下面是 StackOverflow 网友针对“你看到过的最好的代码注释是什么样的？”这个问题给出的回答的前10条。

    我受 HTML 的启发，其代码常常非常清晰，因为你能看到一个标签从哪儿开始、到哪儿结束。一目了然，下面是我相应做出的注释风格.....

    但是，当我开始应用代码大全里学到的东西，开始编写经常比我之前写的注释还要整洁的代码时，我意识到，我给那些接手我代码的人所帮的忙，要比单纯地写注释更有益处。我正在让我的代码更加整洁。

    当注释代码时，要考虑到不仅将来维护你代码的开发人员要看，而且你自己也可能要看。用Phil Haack大师的话来说就是：“一旦一行代码显示屏幕上，你也就成了这段代码的维护者”。因此，对于我们写得好(差)的注释而言，我们将是第一个受益者(受害者)。

    1、逐层注释 使用统一格式对每一个语句块进行注释，如： * 类：简单描述、作者、最后修改时间等 * 方法：关于该方法的目的、函数、参数、返回值的描述 在团队工作中，使用统一的注释规范显得尤为重要。当然，也推荐使用一些专门用来添加代码注释的工具，如C#中的XML、Java中的Javadoc等。 2、使用段落型注释 将代码分割成能完成独立任务的段落，并在其前后添加注释，告诉读者程序将要做什么。 3、对齐连续的行注释

    本刊评论下面是stackoverflow网站上网友针对你看到过的最好的代码注释是什么样的？这个问题给出的回答的前10条： // 亲爱的维护者： // 如果你尝试了对这段程序进行‘优化’， // 并认识到这种企图是大错特错，请增加 // 下面这个计数器的个数，用来对后来人进行警告： // 浪费在这里的总时间 = 39h /** * 致终于来到这里的勇敢的人： 你是被上帝选中的人，英勇的、不辞劳苦的、不眠不修的来修改 我们这最棘手的代码的编程骑士。你...

    任何一个程序员都会告诉你，编程中有时你会气得叫骂不已。但你是否知道写C++程序会比写PHP程序或Python程序引起你更多的咒骂呢？ 一个叫Andrew Vos的开发人员在寻找一个可以业余时开发的项目时突发奇想，他决定在GitHub上抓取100万条程序注释、评论信息，对其进行扫描，看看里面有多少脏话。