P.CMT.01 注释跟代码一样重要，应按需注释

【描述】

一般应通过清晰的软件架构，良好的符号命名来提高代码可读性；在需要的时候，才辅以注释说明。 注释是为了帮助阅读者快速读懂代码，所以要从读者的角度出发， 按需注释。

注释内容要简洁、明了、无歧义，信息全面且不冗余。

需要注释的地方没有注释，代码则难以被读懂；而包含无用、重复信息的冗余注释不仅浪费维护成本， 还会弱化真正有用的注释，最终让所有注释都不可信。

注释跟代码一样重要。

写注释时要换位思考，用注释去表达此时读者真正需要的信息。在代码的功能、意图层次上进行注释， 即注释解释代码难以表达的意图，不要重复代码信息。

修改代码时，也要保证其相关注释的一致性。只改代码，不改注释是一种不文明行为，破坏了代码与注 释的一致性，让阅读者迷惑、费解，甚至误解。

使用流利的中文或英文进行注释。

为降低沟通成本，应使用团队内最擅长、沟通效率最高的语言写注释；注释语言由开发团队统一决定。