好代码就是注释--你被骗了

“好代码本身就是最好的文档。当你需要添加一个注释时，你应该考虑如何修改代码才能不需要注释”
实际上很多程序员的编码能力不足以达到“代码本身就是最好的文档”。即使一个团队中，大家都能互相理解其他人的代码，可以实践“代码即注释”，但是对于一个没有刚刚加入团队的新人来说，注释+代码才是最容易帮助理解逻辑流程的东西，如果这个新人是刚毕业的学生，那么代码也很难达到“代码就是最好文档”的程度，在一个团队中注释文档是不可以省略的。如果接手一个遗留系统的时候，你就会发现注释是如何的重要了，代码注释影响着软件生存周期内所有的维护者。

代码的注释不应该只是当前这行代码做什么，更重要的是解释为什么这么做，是什么历史原因、业务限制导致必须实现这种逻辑。在一个业务系统中，可能代码的算法逻辑很少，能够很容易了解当前代码的逻辑流程，但是里面的判断条件有可能莫名其妙，如果没有熟悉业务的同事解说，那就麻烦了。对于编码人员来说，如果代码实现的逻辑因为业务的特殊限制或者算法比较复杂，都应该加入注释说明。

我所在业务团队同事对代码的注释，标注的很详细，我基本上很容易理解要为什么这样做，明天重新检查下自己的代码是否有不符合规则的地方