代码坏的味道22:过多的注释 (Comments)
2010-08-02 09:05
197 查看
我们之所以在这里提到注释,是因为人们常把它当做除臭剂来使用。常常会有这样的情况:你看到一段代码有着长长的注释,然后发现,这些注释之所以存在是因为代码很糟糕。
注释可以带我们找到代码中的坏味道。找到坏味道后,我们首先应该以各种重构手法把坏味道去除。完成之后我们常常会发现:注释已经变得多余了,因为代码已经清楚说明了一切。
如果你需要注释来解释一块代码做了说明,试试Extract Method (提炼函数);如果函数已经提炼出来,但还是需要注释来解释其行为,试试 Rename Method (函数改名);如果你需要注释说明某些系统的需求规格,试试 Introduce Assertion (引入断言)。
注释可以带我们找到代码中的坏味道。找到坏味道后,我们首先应该以各种重构手法把坏味道去除。完成之后我们常常会发现:注释已经变得多余了,因为代码已经清楚说明了一切。
如果你需要注释来解释一块代码做了说明,试试Extract Method (提炼函数);如果函数已经提炼出来,但还是需要注释来解释其行为,试试 Rename Method (函数改名);如果你需要注释说明某些系统的需求规格,试试 Introduce Assertion (引入断言)。
相关文章推荐
- 代码的坏味道之二十二 :Comments(过多的注释)
- AndroidStudio代码风格之保留单行(one line comments)的文档注释(JavaDoc)
- 3.22 comments (过多的注释)
- android studio添加代码(方法)注释功能
- vim注释代码
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- doxygen 使用简介(C,C++为代码作注释)
- 关于代码注释的一些问题
- 照葫芦画瓢-comments(注释)
- 注释代码的13技巧
- 个人笔记------注释代码(神兽)
- 机器学习实战之KNN算法识别手写数字_代码注释
- 2.3 添加代码注释;2.4 术语
- 代码坏的味道21:被拒绝的遗赠 (Refused Bequest)
- csharp 中为整段代码加注释
- 代码的坏味道【2】
- EA强大功能之代码注释
- theano-xnor-net代码注释2 cnn_utils.py
- 代码注释技巧