2013-04-23 61 views
2

在构建我们的文档时,我们决定使用一些自定义标签在类级别添加细节,并利用Ant任务进行构建。这里的蚂蚁任务目标的一个样本:Javadoc中的多个自定义标签单独显示?

<target name="doc"> 
    <javadoc 
     access="public" 
     additionalparam=" -tag SequenceStep:a:&quot;Sequence Step:&quot;" 
     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()方法个s方法二()方法两个细节

我的期望是让@param的工作更加相当,每次使用标签列出一个。

任何人都可以提供有关如何获得以下输出之一的建议,如果可能的话?

顺序步骤:

methodOne()方法一个具体

methodTwo()方法二细节

序列步骤:

methodOne()方法一具体

顺序步骤:

methodTwo()方法二细节

回答

1

尝试这种情况:

/** 
* @SequenceStep 
* <p>{@link package.DummyClass#methodOne()} Method one specifics</p> 
* <p>{@link package.DummyClass#methodTwo()} Method two specifics</p> 
*/ 
+0

我同意作为一个解决方法,让我在那里,但我希望不必让我们所有的开发人员不得不k现在在他们的代码中嵌入HTML。 – jenrmagas 2013-04-23 20:01:49

+0

在这种情况下,我注意到这些其他的javadoc选项可能会有所帮助:-taglet和-tagletpath。这就是说,一些简单的HTML标签的知识是常见的和有用的。我个人会认为这更多是一个培训问题。 – 2013-04-23 20:10:22

+0

html的知识不是问题,我只是在寻找替代方案。我确实看到了-taglet选项,但是我没有看到任何可以多次完成的细节。你能否指出我所指出的那些具体内容? – jenrmagas 2013-04-23 23:16:56

相关问题