注释Java注释约定

Question

哪种评论方法最被广泛接受，或者它真的很重要

我一直在用

/**  
 * (Method description)
 * @param
 * @return
 * etc
 */

然而，我读到：

Precondition:
Postcondition:

有没有更“专业”的评论方式

Answer 1

以下是Oracle推荐的注释的Java编码约定：

• http://www.oracle.com/technetwork/java/codeconventions-141999.html#385

以下是谷歌对其Android平台的建议：

• https://source.android.com/source/code-style.html#use-javadoc-standard-comments

有关Javadoc样式和约定的更多详细信息，请参见：

• How to Write Doc Comments for the Javadoc Tool

Answer 2

我只需要遵循Sun（Oracle）定义的编写Javadoc的标准。Javadoc被所有开发者一致引用：）。有关更多信息，请单击here

我还想请你们做下面的search on Stackoverflow来回答很多关于评论的问题和回答

https://stackoverflow.com/search?q=commenting

Answer 3

首先，拥有可读的代码和可读的注释是完全不同的两件事

可读代码是使用好的变量、方法、类名等的代码

易读的评论更多的是个人品味的问题。有些人喜欢评论遵循语法规则，而有些人则不在乎语法方面的东西。您可以通过以下链接：

http://www.oracle.com/technetwork/java/codeconventions-141999.html#385

通过可读代码和注释，您可以在doxygen的帮助下创建文档

http://www.doxygen.nl/manual/docblocks.html