优秀代码注释的5个技巧

别以为你可以理解自己写的代码，过了两个星期之后，你可能就不知道代码是不是自己写的。

如果是简单的代码，不加注释情有可原，但是，复杂的代码那就必须加注释了。

1、代码注释最基本的原则

　　代码注释一定是注明代码的目的，而不是代码的行为。为何呢?因为通过代码我们就可以清楚行为，多加注释，画蛇添足。

2、使用空格对齐注释行

　　为了方便阅读起见，代码注释对齐会更好一些。那么问题来了，是用tab对齐还是用空格键对齐呢?

　　我们都清楚，tab在不同的编辑器和集成开发环境中是不一样的，所以选择空格键对齐会适合一些。

　　const MAX_ITEMS = 10; // maximum number of packets

　　const MASK = 0x1F; // mask bit TCP

3、代码少而精

　　如果说代码注释一定要有，那就就要尽量做到少而精。有些人代码注释写的跟小说一样，这后果是相当严重的...

4、代码“统帅”段落

　　一些程序员习惯将代码分成多个“段落”，这是非常要好的一个习惯。当然，加个代码注释就会锦上添花。比如在段落代码前加个注释。同样地，就是告诉自己或者维护人员代码的意图。

5、代码注释的精髓