在构建文档时,我们决定使用一些自定义标记来在类级别添加细节,利用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>
*/