目前我正试图通过ant脚本创建自定义的javadoc标记,以在类级注释中声明一些属性。
我需要创建一个自定义标记,它类似于方法级别的@param标记。该标记可以在类级别中声明n次。
/**
* @argument name of the argument1: description1
* @argument name of the argument2: description2
*/
public class MainClass{
}
我希望javadoc生成如下:
Arguments:
name of the argument1: - description1
name of the argument2: - description2
目前,我使用以下语法创建自定义标记,以下语法生成JavaDoc,将所有参数作为一个文本附加,因为无法拆分参数。
<tag name="<Name of the Tag>" scope="all" description="<Description about the tag>"/>
Arguments:
name of the argument1: - description1, name of the argument2: - description2
实际上,Ant中的<tag>
标记只是指定javadoc
工具的-tag
参数的一种方式。请参见此处。
-tag
参数的输出不太可自定义。所以我不认为你可以通过这种方式实现你想要的。
但是,您可以实现自己的标记处理程序(或者,Javadoc称之为Taglet(,并完全自定义其输出。有关详细信息,请参阅Taglet文档。
在Ant中,您可以使用<taglet>
标记在构建过程中使用它。
感谢您的回复Stefan。我也尝试过这个选择,但没有成功。
<taglet name="<packagename>.<Classname">
<path>
<pathelement location="bin"/>
</path>
</taglet>
</javadoc>```
Taglet is registering properly but i get below warning and the tag information is not present in the generated html page.
[javadoc] Registered Taglet packagename.ArgumentsTaglet ...
[javadoc] Standard Doclet version 1.8.0_121
[javadoc] Building tree for all the packages and classes...
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] Generating C:tempProjectsTagletCreationdocshelp-doc.html...
[javadoc] Note: Custom tags that were not seen: @arguments
[javadoc] 100 warnings
Note: I am using Java 1.8 version.