2011-05-24 49 views
8

我想在我的javadoc中使用自定義標籤,但堅持某種約定,以便其他人可能更容易理解它們。在Oracle的官方javadoc文檔頁面上,他們列出了基本標籤,這是一小組,與我的編輯器的javadoc代碼提示中顯示的標籤列表相比較。流行的javadoc標籤使用的一個很好的參考?

在線是否有很好的參考文獻,其中列出了流行的javadoc標籤?

回答

9

StackOverflow的用戶Uri已經提供了他提出作爲他的博士研究的一部分進入的javadoc的有效性作爲answer到相關question自定義標籤的列表。你可以採用這些方法,並且有一些信心,你正在使用一些由研究支持的東西。

就我個人而言,我只是堅持使用標準的javadoc標籤,並堅持Oracle(Sun's)How to Write Doc Comments for the Javadoc Tool中提到的最佳實踐。

1

不是一個真正的問題的答案,但相關:

要使用自定義javadoc標記,你要麼必須使用定製的doclet(可支持它想要的任何標籤),使用自定義taglets與標準doclet ,或使用-tag命令行參數來定義這些標記。否則,您將從javadoc收到警告(並且此標記沒有輸出)。

因此,當您已經與使用它們的人合作時,使用自定義標籤纔有意義,並且這個人會說您必須使用哪些javadoc選項。 (或者你自己添加這些選項)。

我不使用任何非標準標籤,標準標籤對我來說已經足夠了。

0

我發現這個link爲Javadoc標記的例子