cleanCode-注释

作为程序员，无论是工作还是学习，注释都如影随形。好的注释可以帮助我们理解代码，提高阅读代码的速度。同样，坏的注释也可以给我们帮不少的倒忙。那么，注释究竟在代码中扮演了什么样的角色？写注释的时候要注意些什么来保证它持续发挥正面的作用呢？
    1.对于作者这种英语母语的程序员来说，注释只是一种“必须的恶”，因为可以通过代码的表达力来描述代码本身的意图。但是对于非英语母语的程序员来说，注释应该具有更多的价值。但是随着版本控制系统的发展和运用，我们可以把更多的信息记录在版本控制系统而非代码中。也许烂代码需要一些好注释来做指路明灯，但是请相信能写出烂代码的程序员一定写不出优秀的注释。所以，请不要写注释。
    2.然而有些时候，注释是不可避免的。打开java的api，注释随处可见。在一些提供基本能力的api中，会使用大量的篇幅描述某些方法或者某些类的详细信息。这些注释帮助我们节省了许多时间。如果代码足够稳定，注释是提高效率的一种方式。反之，如果代码一直都在扩展和更新，那么注释就很容易变成垃圾和病毒，误导后来人。
    3.如果需要注释才能够描述清楚代码的意图，那么代码是一种表达上的失败。每一处注释的内容，都可以通过重构代码更好的表达出来。除非，你想告诉其他人一些代码之外的事情。也许是业务规则，也许是现实的局限。
    4.不要试图认为被注释掉的代码还有可利用的机会。它们是代码中最被重视的废物了。
    5.如果写注释，请务必明确。详细讲清楚前因后果。可以找一个不知情的人来阅读你的注释看看是否理解了注释所描述的事情。
    6.有些注释奖就像脚手架，可以帮助我们来写代码。写完代码之后或许也可以保留来帮助其他人快速理解代码的意图。但是随着时间的流逝，注释终将变质，毒害一波试图理解它的人。根据经验，鲜有人会坚持更新注释。