不要为没有注释找借口

 

转自 http://blog.jobbole.com/586/ 

提高代码可读性的10个注释技巧 第九条

在写代码时就添加注释，这时在你脑海里的是清晰完整的思路。如果在代码最后再添加同样注释，它将多花费你一倍的时间。而“我没有时间写注释”，“我很忙” 和“项目已经延期了”这都是不愿写注释而找的借口。一些开发者觉得应该write comments before code，用于理清头绪。

 

第十条

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