Java 注释约定 [关闭]答案

【问题标题】：Java Commenting Conventions [closed]Java 注释约定 [关闭]
【发布时间】：2011-04-05 07:58:04
【问题描述】：

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

我一直在用

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

但是我读过：

Precondition:
Postcondition:

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

【问题讨论】：

【解决方案1】：

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

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

可读的 cmets 更多的是个人喜好问题。有些人喜欢 cmets 遵循用于写书的语法规则，而另一些人则不太关心语法内容。你可以通过这个链接：

从可读的代码和 cmets 中，您可以在 doxygen 的帮助下创建文档。

【讨论】：

【解决方案2】：

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

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

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

【讨论】：

【解决方案3】：

This 链接非常有用，我已经使用了很长时间，对我帮助很大。这将创建一个非常好的和文档化的代码，具有最大的可读性。

【讨论】：

【解决方案4】：

我会简单地遵循 Sun (Oracle) 为编写 Javadoc 定义的标准。 Javadoc 被所有开发人员一致引用:)。更多信息请点击here

我还请您关注search on Stackoverflow 以获取大量关于评论的问题和答案。

【讨论】：

【解决方案5】：

您的第一个示例中的注释样式不仅仅是一种约定，它还是一个名为Javadoc 的文档工具的标准。如果您遵循 Javadoc 注释风格，您将能够轻松地为您的所有源代码生成 html 格式的文档。

【讨论】：