Java 注释代码

什么是评论代码最专业、信息最丰富的方式。有什么标准吗

p、 它不必是javadoc，只需包含一些信息——任何常见的布局等

---

cheers guys

Java定义了代码注释标准。试试这个

我想这要看情况而定，javadoc适合更大的项目。如果它是一个小项目或学校作业，在方法标题前的一个小描述会很好，可能会在方法中穿插一些注释，以防你以非正统的方式做事。在这些之前，我建议你给你的方法提供信息性的名称以及变量和参数，这样比阅读并试图弄清楚每个参数的确切用途等更容易推断出方法在做什么…

注释内部方法代码和注释之间有很大的区别API

对于代码，我不熟悉特定的实践或布局。“使用常识”是最好的。不要记录代码中任何明显的内容，等等，但要记录所有不清楚的内容。记住，比没有注释的代码更糟糕的一件事是带有过时注释的代码。更多的评论意味着更多需要更新的东西

对于API文档，有两种方法。文档中的每件事都有大量的细节（由Sun提出），而且更灵活（只提出重要的部分）。在许多地方，您不需要记录签名中显而易见的API内容

虽然完整的方法文档（sun方法）对于充实规范很重要，但我的研究表明，它使发现重要的警告变得更加困难，可能导致更多的错误

---

关于API，另请参见：

我曾经被教导使用前置条件、后置条件和注释每个方法将修改的数据结构。这是在学校。我在工业界从未见过这样的事

我使用创建文件/META-INF/CHANGELOG并使其保持最新（例如，2010年12月10日添加了功能A）

我们通常在源文件夹中创建自述文件，并在其中快速描述整个项目（例如：项目具有功能A，这些类正在处理功能A。要添加子功能子功能子功能修改类Foo…）

在评论中，试着描述你在做什么以及为什么要做，但不要描述你是如何做的（例如，“让我们在价格中找到最大价值，我们将在表头显示它”…但不要：“在for循环中找到最大价值”）

---

Steve McConnel的书《代码完成》——无疑是关于如何编写软件的最好的书——有一整章是关于如何编写注释和以其他方式确保您的代码被理解的——称为“自我文档化代码”。

请尝试以下问题+1，了解过时的注释