管理感悟：需要什么样的注释

管理感悟：需要什么样的注释

　

　

红朝儒生

2016-4-12

　

关键字：管理 程序 注释

简介：禁止程序员给程序增加垃圾注释，因为这些垃圾注释对工作不仅没有好处，反而有害。吾要求添加好的注释，也就是有用的注释，即：增加知识点、帮助别人理解相应代码。

　

　

　　有同事改代码，加了“add by xxx”、只有函数名之类常见的注释。吾立即阻止：不要写这样的注释。

　　有人就奇怪啦，每个软件公司，都鼓励程序员尽量写注释，怎么到了汝这里，竟然不要别人写注释？

　　吾回答曰：这种没用的注释，吾称之为垃圾注释；而这种垃圾注释，对于工作没有任何帮助，所以必须删除。

　　实际上，这种垃圾注释，不仅不利于工作，反而添乱：

　　看到这种注释，对于工作有任何用处吗？没有。

　　这种注释分散了程序员的注意力，让程序员以为另有含义。

　　增加了代码量。

　　

　　吾主张不要这种垃圾注释，但是依然鼓励好的注释。什么叫好的注释？即有用的注释。什么叫有用？吾思考良久，下了如下定义：

　　增加知识点、帮助别人理解相应代码的注释，就是好的注释。

　　比如，吾调试视频程序崩溃，经过跟踪，发现是因为1088的视频画面高度转移到1080时引起的。这里就要加注释了，说明存在这种情况。吾还到网上学习了多出的8行，是在画面底部，这样就决定了程序的处理算法。为此吾专门加了大段注释。看到此类代码的程序员，学习了这个知识，也就明白了这边的算法原因。

　　

　　注释是否有用？这个又信赖于程序员的看法。如果有用无用都判断不准确，那说明这个程序员不合格。实际上，以吾观察，合格的程序员并不多。当然了，这也是因为吾所言“合格”，其实是要求很高的。