【实践】如何合理地在代码中添加注释

      从开始学编程到今天之前，看到各种书籍资料中都提到为了自己养成编码的好习惯，并且让自己以后及其他相关人员能看懂代码，要对代码添加注释。但今天，本以为自己已经“养成”了这个所谓的好习惯而沾沾自喜时，老大却把我“教训”了一番：添加注释不要过于“滥”，要合理适度。

      以前看到添加注释方面的资料介绍时，自己都很认真谦虚地学习，所以在我自己的代码中，都用英文名称（本人英文还算不错）尽量把类，枚举，各种方法，成员变量，属性等等写得让人一看就明了的感觉。这的确是个不错的习惯，怪不得有些牛人们经常说：“我的代码就是注释！”直到今天被老大“教训”我时，我才算真正明白了这点。

      老大说：“既然名称都已经明了了，那为什么还要加那么多的注释呢（几乎每行都加），我们又不是像微软SUN那样做底层的，不会把注释都转换成API开发接口文档。我们应该把注释加在那些需要在今后引起人们注意的代码上，比如这里可能抛异常，那里为什么要用A方式来做而不用B方式，当然还有在意思上比较模糊让人混淆的地方等等。”

      代码注释的方式，从来就没有一个完全的定义，要么是根据微软SUN这些公司建议的规则（也仅仅是建议而已），要么是根据项目自身需要来制订的。但我们更能通过平时的工作来学会更加成熟地为代码添加注释---不是越多越好，应该合理适度。