流行的javadoc标签使用的一个很好的参考?

时间:2011-05-24 17:13:02

标签: javadoc

我想在我的javadocs中使用自定义标签,但坚持某种惯例,以便其他人可能更容易理解它们。在Oracle的官方javadoc文档页面上,他们列出了基本标签,这是一个小集,与我编辑器的javadoc代码提示中出现的标签列表相比较。

是否有一个很好的在线参考,列出了流行的javadoc标签?

4 个答案:

答案 0 :(得分:9)

StackOverflow用户Uri提供了一个自定义标记列表,作为他对javadocs作为answer到相关question的有效性的博士研究的一部分。你可以采用这些并且有信心你正在使用某些研究支持的东西。

就个人而言,我只是坚持使用标准的javadoc标签,并遵循Oracle(Sun's)How to Write Doc Comments for the Javadoc Tool中提到的最佳实践。

答案 1 :(得分:4)

答案 2 :(得分:1)

不是问题的答案,但相关:

要使用自定义javadoc标记,您必须使用自定义doclet(可以支持所需的任何标记),将自定义标记使用标准doclet,或使用-tag命令行参数定义这些标记。否则,您将收到来自javadoc的警告(并且此标记没有输出)。

因此,当您已经与使用自定义标签的人合作时,使用自定义标签才真正有意义,而且有人会告诉您必须使用的javadoc选项。 (或者你自己添加这些选项)。

我不使用任何非标准标签,标准标签对我来说已经足够了。

答案 3 :(得分:0)

我发现这个link有关javadoc标签的例子