注释

引言

         “什么也比不上放置良好的注释来得有用。什么也不比乱七八糟的注释更有本事搞乱一个模块。什么也不比陈旧、提供错误信息的注释更有破坏性”。注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。比如我们在一个文件中提供了两个方法func1和fun2分别用于不同的系统版本，但是在这两个方法中我们可能没办法描述清楚它们分别对应哪个版本，所以我们只能给他们分别添加注释来说明在不同的版本应该调用哪个方法。但是注释多并不是一件好事，我们应该尽量避免使用注释。因为通常我们写的代码会变动，在演化，但是注释并不一定会随着代码合理的移动、变化。那么这将导致我们的注释越来越不准确。

       注释并不能美化糟糕的代码，往往我们写注释的动机之一是代码比较糟糕，读者在阅读代码时不容易清楚其中的逻辑。在我们写注释之前，我们应该首先分析我们的注释是否是必要的，我们的代码是否足够清晰、有表现力。我们作为程序员应该负责将注释保持在可维护、有关联、精确的高度。但是更应该把力气花费在写清楚代码之上，直接保证无需编写注释。

编写好的注释

       要么不写注释，要写就要写好注释。好的注释应该遵循以下几点：

               1、项目中注释格式尽量保持统一              

               2、注释简单、明了

               3、不写误导性注释

               4、不要保留注释掉的代码