到底怎样写注释？

昨天随便浏览，看到一个牛B人物，鼓吹《重构》，鼓吹“自注释”理论。

我不想去他的博客去喷了。

这个人很明显不接地气，读死书。

1、《重构》作者的母语是英语，他探讨的也是英语世界。对于老外来说，读英文代码比我们轻松得多，英语世界使代码的“自注释”更具实践意义。

我们通过汉语的标记，去理解代码更轻松些。既然有汉语注释可读，为什么还要通过读代码理解意思呢？

所以，代码自注释，远远不如加上几句汉语说明，更方便阅读。

 

2、代码的注释是干球用的？是维护用的。不是为了“读代码”用的。而是为了在茫茫的代码之中，快速找到需要修改的地方，迅速确定关键代码的位置。

我个人非常习惯在关键的地方加上注释，我认为这个地方将来需要考证、维护。我还会写下思路，防止将来忘却，再来重新理解。因为我的产品，生命周期很长，长到我足以忘记所有细节。

 

这个人估计：

1、毕业没多长时间

2、经常在“团队”中工作

3、总是负责一小坨功能的编写

4、写完了有没有人用还不知道

 

读本《重构》就了不起了？谈代码，必“重构”；谈注释，必谈“自注释”。

唉，孩子，孩子，你为什么这么坏？

 

2013年04月09日 于 济南。