使用流行的 javadoc 标记的一个很好的参考？答案

【问题标题】：A good reference for popular javadoc tags to use?使用流行的 javadoc 标记的一个很好的参考？
【发布时间】：2011-09-01 03:16:06
【问题描述】：

我想在我的 javadocs 中使用自定义标签，但要遵守某种约定，以便其他人可以更轻松地理解它们。在 Oracle 的官方 javadoc 文档页面上，他们列出了基本标签，与我的编辑器的 javadoc 代码提示中出现的标签列表相比，这是一小部分。

网上有没有很好的参考资料，列出了流行的javadoc标签？

【问题讨论】：

标签： javadoc

【解决方案1】：

您可以使用this 站点或github，因为它显示了使用示例并提供了一些关于编码实践的很好的评论。

【讨论】：

【解决方案2】：

我在link 中找到了 javadoc 标签的示例

【讨论】：

【解决方案3】：

【讨论】：

【解决方案4】：

StackOverflow 用户 Uri 提供了一个自定义标签列表，作为他对 javadocs 有效性的博士研究的一部分，他建议将其作为 answer 到相关的 question。您可以采用这些方法，并确信您正在使用一些有研究支持的东西。

就我个人而言，我会坚持使用标准的 javadoc 标签并遵守 Oracle（Sun 的）How to Write Doc Comments for the Javadoc Tool 中提到的最佳实践。

【讨论】：

遗憾的是，第一段中提到的问答页面已被删除。但是，Oracle 页面仍然存在并且似乎是最新的；它还链接到一些相关页面。对于不太详细的信息，Javadoc 上的 Wikipedia 页面非常好，并且列出了很多标准标签。

【解决方案5】：

不是问题的真正答案，而是相关的：

要使用自定义 javadoc 标签，您要么必须使用自定义 doclet（它可以支持它想要的任何标签），要么使用带有标准 doclet 的自定义 taglet，或者使用-tag 命令行参数来定义这些标签。否则你会收到来自 javadoc 的警告（并且这个标签没有输出）。

因此，只有当您已经与使用自定义标签的人合作时，使用自定义标签才真正有意义，并且有人会告诉您必须使用哪些 javadoc 选项。（或者您自己添加这些选项）。

我不使用任何非标准的标签，标准的对我来说就足够了。

【讨论】：