java - Java中应该有什么javadoc？

Question

javadoc 注释应该记录什么内容(类、方法、构造函数和字段？还是只有类方法和构造函数？)？有这方面的约定吗？

请尽可能在您的答案中提供相关资源的链接。谢谢

编辑:问题不在于通常如何完成或使用 javadoc 进行注释的逻辑是什么。问题是在任何 Sun/Oracle 官方文档(有关编写 javadoc、约定、规范等的指南)中可以找到有关此问题的内容。另外，请不要回答 javadoc 注释应该是什么样子，问题具体是关于应该注释什么，而不是如何注释。

Answer 1

Javadoc 用于记录代码的公共(public) API。

简而言之，您需要记录所有公共(public)和 protected 类、方法、构造函数和字段(因为您的用户可以访问它们)。

您需要描述方法的作用，而不是它是如何做的。当然，如果实现细节导致有趣的副作用，例如性能特征以及使用限制，则应该提及这些。

Oracle 有关于“How to Write Doc Comments for the Javadoc Tool ”的官方指南。