Java评论公约

Question

哪种评论方法被广泛接受或者真的重要？

我一直在用

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

不过我读过:

Precondition:
Postcondition:

是否有更"专业"的评论方式？

Answer 1

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

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

以下是Google对其Android平台的推荐:

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

有关Javadoc的样式和约定的更多详细信息,请参阅此处:

• 如何为Javadoc工具编写Doc注释