JAutodoc - Eclipse Plugin

系統 2019-08-29 23:25:28 2656 0

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}"/>

before running the JAutodoc task.

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元

自定義

發表我的評論

最新評論總共0條評論