时间戳

首页 > 解决方案 > 如何在 Ant 脚本中创建 Javadoc 自定义标签

ant - 如何在 Ant 脚本中创建 Javadoc 自定义标签

问题描述

目前我正在尝试通过 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

标签： anttagsjavadoc

解决方案

感谢您的回复斯特凡。我也尝试过这个选项，但我没有成功。

         <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:\temp\Projects\TagletCreation\docs\help-doc.html...
  [javadoc] Note: Custom tags that were not seen:  @arguments
  [javadoc] 100 warnings

Note: I am using Java 1.8 version.

推荐阅读