构建文档时,我们决定使用一些自定义标签在类级别添加详细信息,并利用Ant任务进行构建。这是ant任务目标的示例:
<target name="doc">
<javadoc
access="public"
additionalparam=" -tag SequenceStep:a:"Sequence Step:""
author="true"
destdir="ant/doc"
doctitle="Test"
nodeprecated="false"
nodeprecatedlist="false"
noindex="true"
nonavbar="true"
notree="true"
source="1.6"
sourcepath="${src.dir};${test.dir}"
splitindex="false"
use="false"
version="true"
private="on"
failonerror="false">
<classpath path="${full.test.classpath}" />
</javadoc>
在我正在测试的类的内部,下面是一个示例Javadoc:
/**
* @SequenceStep {@link package.DummyClass#methodOne()} Method one specifics
*
* @SequenceStep {@link package.DummyClass#methodTwo()} Method two specifics
*/
我生成的Javadoc给出了如下所示的部分:
顺序步骤:
methodOne()方法一个细节,methodTwo()方法两个细节
我的期望是获得与@param的工作原理等效的东西,并在每次使用该标记时列出一个。
如有可能,任何人都可以提供有关如何获取以下输出之一的建议吗?
顺序步骤:
methodOne()方法一的细节
methodTwo()方法两个细节
要么
顺序步骤:
methodOne()方法一的细节
顺序步骤:
methodTwo()方法两个细节
最佳答案
尝试这个:
/**
* @SequenceStep
* <p>{@link package.DummyClass#methodOne()} Method one specifics</p>
* <p>{@link package.DummyClass#methodTwo()} Method two specifics</p>
*/