代码注释的作用已被程序员广泛讨论。很多人认为注释没有必要，写注释是代码可读性太差。原作者PauloOrtins发表博文《5 reasons to avoid code comments》，以下为译文：通常，我们阅读软件的时间多于编写软件的时间。虽然我从未见过任何科学研究可以证明这一点，但在软件中它就像教条或信念一样根深蒂固。因为编写软件比阅读软件容易，所以代码的可读性更为重要。程序员可以通过多种技术实现这一点，其中之一包括代码注释。网上有很多讨论代码注释的文章。我们应该使用注释来解释代码吗？还是我应该专注于编写表达式代码而不阅读注释？JoeKunk曾经发表过一篇文章《To Comment or Not to Comment》，说所谓好的代码就是我们应该避免注释，因为注释通常用来解释/隐藏恶意代码。让我们讨论避免编写代码注释的五个原因：1.程序员更倾向于鼓励“糟糕”的代码。有句话说，有注释的代码才是好代码，所以程序员经常在代码旁边写上注释，让它看起来更好看。如果我们将代码注释作为一种信号，那么我们可能正在编写糟糕的代码。每当我们写注释的时候，我们应该考虑如何让代码看起来更干净。2.编写和维护需要更多的时间。如果不遵循代码的变化，即使是正确的注释也是无用的。注释通常作为代码的第二个版本。在为函数写注释时，我们需要不断重复自己，这违反了DRY（不要重复自己）原则。时间花在了增加复杂性、软件需求变化和代码变化上。如果我们写评论，那就意味着我们必须维护它们。因此，除非绝对必要，否则我们应该拒绝在评论上花费双倍的时间。相反，我们可以利用这些时间来提高代码质量或开发新功能。3.注解不是测试/验证。修改代码可以依赖工具，比如使用编译器、IDE、单元测试；注释不能。注意如果没有这些工具，您就不能依赖位于正确位置或过时的工具或单元测试来确保它们是正确的。一旦你写了一个注解，没有测试模块来验证它的正确性，一旦注解失败，那么它就永远失败了。4.注释不如代码文档可靠通常，当注释过期时，它们往往会失去与代码的联系。阅读这些评论的程序员可能会被“骗”。即使有不断更新的代码注释，唯一知道的是代码应该是什么以及它的可读性如何。例如，如果Ben问我们项目是否有变化，我们如何才能知道？是代码还是注释？-答案当然是代码。5.代码注释样式占满屏幕空间采用规范的注释尤为重要，有些注释标准（如下）使用很多行，这要求您尽可能多地阅读代码。/****@paramtitleThetitleoftheCD*@paramauthorTheauthoroftheCD*@paramtracksThenumberoftrackssontheCD*@paramdurationInMinutesThedurationoftheCD分钟*/publicvoidaddCD(Stringtitle,Stringauthor,inttracks,intdurationInMinutes){CDcd=newCD();cd.title=tracks=authors;cd.authors;=tracks;cd.duration=duration;cdList.add(cd);}原文链接：http://www.html5cn.org/article-5351-1.html
