我喜欢查看其他人的代码，看看他们如何设计他们的评论，大多数人都混合使用 * 和////，当然这一切都取决于语言，但我肯定已经看到了一些很好的评论方式和一些不好的方法。编码页面可以与正确的评论结构结合在一起，使得在没有任何知识的情况下进入项目的人员可以非常轻松地阅读。
我很想知道人们认为什么是样式评论，部门划分等的最佳方式。这可能适用于html，php或其他任何东西。
答案 0 :(得分：2)
PHP：
我个人使用//来处理方法/函数内部的所有内容。如果有人使用/* */会很烦人，因为它会使注释代码块变得更加困难
出于文档目的，我使用的是phpdoc使用的与javadoc非常相似的内容。
/**
* Overall description
* @keyword - description
*/
通常一个好的规则是，如果你没有任何评论去15-20行，你需要提出一些评论，除非代码是真正的自我解释。虽然当时你可能会认为你会记住你的500线功能及其所做的一切，但你经常不会。如果是其他人试图进入并理解您的代码，那么对他们来说只会更难！
答案 1 :(得分：0)
侧节点（快速链接，不是我的）：http://www.heartysoft.com/ninja-coding-code-comments
为什么我不喜欢评论
我试图避免评论我的代码的主要原因是这个概念 自解释代码。代码应该是自我解释的 - 任何人 阅读代码应该了解正在发生的事情（给定一些域名 知识，当然）。依靠评论来解释发生了什么 这不是一个好主意。代码将经常发生变化 评论得到更新。无论你的团队多么警惕，这都是 必然会发生。充其量，这可能会导致稍微过时 评论。在最坏的情况下，陈旧的评论可能完全误导了什么 代码实际上在做。
-
我总是试图重构我的代码，以便它不需要任何其他描述。
因此，我最终只需要通常的xDoc注释来自动生成APIDoc。即使这些评论也可以在很大程度上自动生成。
在极端情况下（例如操作系统特定问题）我试图找到一个讨论问题的公共网站并添加链接。如果链接在未来时间中断 - 发生了屎。
-
AS3：
/**
* This is a usual doc comment for a type or property.
*/
/*
* This is a marker of a particular longer section of code.
*/
// This is a single line comment before a or at end of a line of code.
答案 2 :(得分：0)
在AS3中，我使用它：
/**
*
* to comment (if necessary) a method or a group of related methods
*
*/
我用这个时：
//
单行注释。
此外，我通常会插入空//个注释以获得更多的代码可重现性。