《代码整洁之道》读书笔记----第四章注释

最好的注释就是代码本身。
良好的编码习惯，规范的命名，可以让代码清晰可读。

好的注释是尽可能少的注释。

可以存在的注释:
1.法律信息
2.提供信息----例如某个变量的用途，最好的办法是通过命名来表现
3.代码意图
4.阐释
5.警示
6.TODO
7.放大不合理之物的重要性
8.公共API的帮助文档

大量的注释会让代码的可读性降低。如果需要编写注释来解释一段糟糕的代码的时候，不如进行代码重构，而且注释随着代码的修改，会带有误导性。