07 注释，真的是小菜一碟吗？

注释是无奈的妥协

在理想的情况下，代码不需要注释。理想的代码，命名恰当，结构清晰，逻辑顺畅，含义显而易见。

注释带来的三个麻烦？

1.因为注释不需要运行，所以没有常规的办法来测试它。注释难以维护，这是使用注释带来最大的麻烦。

2.注释为我们提供了一个借口。我们有时候会过度依赖注释，从而放弃了潜在的替代方案，比如更准确的命名，更清晰的结构，更顺畅的逻辑等等。注释，被我们用成了狗皮膏药，有时会让代码更糟糕。

3.注释的滥用

几种常见注释类型

1.记录源代码版权和授权的

2.用来生成的用户文档的

用来生成独立的，不包含源代码的文档。这些文档帮助使用者了解软件的功能和细节，主要面向该软件的使用者，而不是该软件的开发者。

3.解释源代码的

帮助代码的阅读者理解代码。

注释的三项原则

1.周期 ，错误的注释比没有注释更糟糕

2.必要，多余的注释浪费阅读者时间

3.清晰 混乱的注释会把代码搞得更乱

注释用英文还是中文？

推荐英文注释，在国际化项目中，没有办法使用中文。

https://time.geekbang.org/column/article/78086