2013-04-23 48 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

相關問題