黑马程序员技术交流社区

标题: 对代码注释的一点感想 [打印本页]

作者: Kid1412    时间: 2013-8-4 15:12
标题: 对代码注释的一点感想
前段时间在csdn上看了一篇文章,链接如下http://www.csdn.net/article/2013-07-15/2816224-code-comments,原作者是一个老外,主要讲来论述避免写注释的理由,主要内容就是我总结为下面五点:

1. 程序员更加倾向于鼓励”坏“代码。有一种说法,有代码注释的就是好代码,因此,程序员经常在代码边上写注释,使其看起来更加出色。如果我们把代码注释当做一种信号,那么也许我们正在编写坏代码。每当我们写注释时应该思考如何使代码看清来更加洁净。

2. 花费更多时间来编写和维护

如果注释没有跟随代码的变化而变化,即使是正确的注释也没有用。注释通常作为代码的第二个版本。当为某个函数写注释时我们需要不断的重复自己,这就违反了DRY(Don’t Repeat Yourself) 原则。花费时间来增加复杂性,软件需求改变了,代码也随之跟着变化。如果我们写注释,这就意味着必须去维护注释。因此,除非是很必须要,否则我们应该拒绝在注释上花费双倍时间,相反我们可以利用这些时间来提高代码的质量或开发新的特性。

3. 注释不是测试/验证

修改代码可以依赖工具,比如使用编译器、IDEs及单元测试;而注释却不能。注释没有这些工具,你无法依赖工具或者单元测试在正确的地方或者过期后来确保它们的正确性。一旦你写了注释,没有测试模块来验证它的正确性,一旦这个注释失败了,那么它就永远的失败了。

4. 注释没有代码文档可靠

通常,注释过期后,它们往往与代码失去了连接性。程序员阅读这些注释或许被“欺骗”了。即使不断的更新了代码注释,唯一了解的是这个代码应该是什么以及它的可读性。举个例子,如果老本问我们如果项目发生了更改,我们从哪能看出?是代码还是注释?——答案当然是代码。

5. 代码注释风格填补了屏幕空间

采用标准化的注释尤为重要,某些注释标准使用了很多行,这就要求你尽可能多的阅读更多代码。


感想:其实身为一个程序员,我也确实不喜欢写注释,实在太麻烦了。确实如他们所说的,有些人就认为注释少就不好。其实我觉得注释少不一定不好,又方便阅读,又方便书写,起码能保证不是废话,不是为了写注释而写注释。当然,我说的少,仅仅只的是不写废话,该写的还是要写的,只不过不要应付工作而已。还有文章的第3、4条确实让人头疼,代码就怕改,这一改什么事都来了,特别是注释,程序员容易忽略,IDE的开发者也没有特别好的对策(估计也不重视),起码没有什么很好的“报错”机制吧?不知道有没有谁能开发个能报注释错误的IDE,那多爽啊。

其实就是找了篇文章大家共同学习交流,谢谢




作者: 神之梦    时间: 2013-8-4 22:43
只要是好的文章,欢迎转载到论坛里




欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2