代码的坏味道之二十二 :Comments(过多的注释)
2013-05-03 09:36
357 查看
别担心,我们并不是说你不该写注释。从嗅觉上说,Comments不是一种坏味道;事实上它们还是一种香味呢。我们之所以要在这里提到Comments,因为人们常把它当作除臭剂来使用。常常会有这样的情况:你看到一段代码有着长长的注释,然后发现,这些注释之所以存在乃是因为代码很糟糕。这种情况的发生次数之多,实 在令人吃惊。
Comments可以带我们找到本章先前提到的各种坏味道。找到坏味道后,我们首先应该以各种重构手法把坏味道去除。完成之后我们常常会发现:注释已经变得多余了,因为代码已经清楚说明了一切。
如果你需要注释来解释一块代码做了什么,试试 Extract Method(提炼函数);如果method已经提炼出来,但还是需要注释来解释其行为,试试Rename Method(重新命名函数);如果你需要注释说明某些系统的需求规格,试试
Introduce Assertion(引入断言)。
TIP:当你感觉需要撰写注释,请先尝试重构,试着让所有注释都变得多余。
如果你不知道该做什么,这才是注释的良好运用时机。除了用来记述将来的打算之外,注释还可以用来标记你并无十足把握的区域。你可以在注释里写下自己「为什 么做某某事」。这类信息可以帮助将来的修改者,尤其是那些健忘的家伙。
Comments可以带我们找到本章先前提到的各种坏味道。找到坏味道后,我们首先应该以各种重构手法把坏味道去除。完成之后我们常常会发现:注释已经变得多余了,因为代码已经清楚说明了一切。
如果你需要注释来解释一块代码做了什么,试试 Extract Method(提炼函数);如果method已经提炼出来,但还是需要注释来解释其行为,试试Rename Method(重新命名函数);如果你需要注释说明某些系统的需求规格,试试
Introduce Assertion(引入断言)。
TIP:当你感觉需要撰写注释,请先尝试重构,试着让所有注释都变得多余。
如果你不知道该做什么,这才是注释的良好运用时机。除了用来记述将来的打算之外,注释还可以用来标记你并无十足把握的区域。你可以在注释里写下自己「为什 么做某某事」。这类信息可以帮助将来的修改者,尤其是那些健忘的家伙。
相关文章推荐
- 代码坏的味道22:过多的注释 (Comments)
- 3.22 comments (过多的注释)
- AndroidStudio代码风格之保留单行(one line comments)的文档注释(JavaDoc)
- 代码的坏味道
- eclipse代码注释的设置
- Java代码注释和编码规范
- 小心注释掉的js代码也会引起错误
- 第六章 组织、注释、引用代码(一)
- spring hibernate 整合+项目框架搭建 包含详细注释(清华大学各系统使用代码)
- 词法分析器只做token识别,代码详细注释
- Refactoring之——代码的坏味道(二)过大的类 &(三)基本类型偏执
- java中代码的注释和快捷键
- CSS注释代码
- 提高代码可读性的10个注释技巧
- 『重构--改善既有代码的设计』读书笔记----代码坏味道【5】
- 第7周 C语言程序设计(新2版) 练习1-23 删除C语言程序中所有的注释语句(代码有问题?)
- 七款代码味道识别工具【简介】
- Eclipse JAVA代码开发注释全解
- mybatis-generator-core自动生成代码,支持生成中文注释、支持分页、提供BaseDao封装
- 好玩的代码注释,喜欢拿去!