《代码整洁之道》笔记——第四章:注释

1、应当尽量避免使用注释,代码不能表达自己的意图是一种失败,只有在代码不能表达自己意图的时候才选择使用注释。

2、不准确的注释远比没有注释坏得多。

3、与其花时间用注释去解释糟糕的代码,不如花时间去吧糟糕的代码弄好点。

4、TODO注释有必要存在,但是应该尽快完成未做的工作。

5、在需要注意的代码部分可以写下注释警示后面的人注意这部分代码。

6、注释中应该只含有应该描述的信息,不要包含无用的信息。

posted @ 2020-02-24 18:09  夜里寻星  阅读(147)  评论(0)    收藏  举报