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

如何解决如何在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

解决方法

实际上，Ant中的<tag>标签只是指定-tag工具的javadoc参数的一种方式。参见here。

-tag参数相对于其输出不是非常可定制的。所以我认为您无法以这种方式实现您想要的。

但是，您可以实现自己的标记处理程序（或Javadoc称之为：Taglet）并完全自定义其输出。有关更多信息，请参见Taglet documentation。

然后在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:\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.