JAutodoc - Eclipse Plugin

JAutodoc provides an Ant task, that can be used inside the Eclipse environment.

Ant task for Eclipse

In order to use it, select "Run As->Ant Build..." for the Buildfile

and choose the option "Run in the same JRE as the workspace"

If you generate new source code during the build, you may need to refresh the workspace using the following task:

<eclipse.refreshLocal resource="${ant.project.name}"/>

Options

The JAutodoc task has the following options. Defaults are always taken from the current Workspace or Project specific settings.

Attribute	Description	Required
srcdir	Location of the java files.	No; default is `src`
includes	Comma- or space-separated list of files (may be specified using wildcard patterns) that must be included; all .java files are included when omitted.	No; default is `*/.java`
excludes	Comma- or space-separated list of files (may be specified using wildcard patterns) that must be excluded; no files (except default excludes) are excluded when omitted.	No
verbose	Log the files that are being processed.	No; default is `false`
mode	The mode to use: `complete` - Complete existing Javadoc `keep` - Keep existing Javadoc `replace` - Replace existing Javadoc	No
public	Comment public members `(true\|false)` .	No
package	Comment package members `(true\|false)` .	No
protected	Comment protected members `(true\|false)` .	No
private	Comment private members `(true\|false)` .	No
types	Comment Types `(true\|false)` .	No
fields	Comment Fields `(true\|false)` .	No
methods	Comment Methods `(true\|false)` .	No
getsetOnly	Comment Getter/Setter only `(true\|false)` .	No
todo	Add ToDo for auto-generated Javadoc `(true\|false)` .	No
comment	Create comment from element name `(true\|false)` .	No
single	Single line field comment `(true\|false)` .	No
format	Use Eclipse comment formatter `(true\|false)` .	No
header	Add file header `(true\|false)` .	No
replaceHeader	Replace existing header `(true\|false)` .	No
multiHeader	Multi comment header `(true\|false)` .	No
headerOnly	Add header only (No Javadoc created) `(true\|false)` .	No

Nestet Filesets are supported.

Examples

Comment all sources using the current Project/Workspace settings

<jautodoc srcdir="src" includes="**/*.java"/>

Creating Header only

<jautodoc srcdir="src" includes="**/*.java" headeronly="true"/>

JAutodoc - Eclipse Plugin

更多文章、技术交流、商务合作、联系博主

微信扫码或搜索：z360901061

微信扫一扫加我为好友

QQ号联系： 360901061

您的支持是博主写作最大的动力，如果您喜欢我的文章，感觉我的文章对您有帮助，请用微信扫描下面二维码支持博主2元、5元、10元、20元等您想捐的金额吧，狠狠点击下面给点支持吧，站长非常感激您！手机微信长按不能支付解决办法：请将微信支付二维码保存到相册，切换到微信，然后点击微信右上角扫一扫功能，选择支付二维码完成支付。

【本文对您有帮助就好】元

2元

5元

10元

20元

自定义