《Clean Code》 第四章——Comment 总结

《Clean Code》 第四章——Comment 总结

今天下午学习了下《Clean Code》的第四章，这一章总的来说还是比较简单的，里面的一些思想在前几章都有接触过。当然也从里面悟出了一些自己的体会，下面就来简单总结下。

要以代码作为注释为主体

这个小标题的意思是说，我们要尽量用代码去栓释我们索要表达的意思，基本上使用前两章所学的就可以做到了。我们要以尽量为零注释为目标，当有的通过Code Review 怎样都无法表达好的情况下才考虑添加注释。

添加注释一定要小心

当必须要添加注释时，必须要仔细思考，想出最适合的语句，千万不要让注释具有迷惑性，做到通俗易懂，简短易读（可以节省了解代码时间）。

添加对意图的理解的注释

首先要强调的是一定要尽量少的添加注释，尽量让代码说话，对于一些复杂的算法，无法通过代码清楚的表达其意思的，可以增加适当的注释。

以提升理解速度为目的

我们要明确添加注释的目的：是以提升理解速度为目的。任何注释都应该为了可以让人能够更快的读懂你的代码而存在，当然不单单是注释，我们可以通过代码来表达思想（一般这样往往更节省时间）。

TODO注释的理解

TODO注释可以标注你想要实现但是暂时没有时间去实现的代码，这样可以暂时记住你要实现的功能，方便以后实现时理解要实现的功能。但是千万不要让这些注解长期存在，因为这样会让你的代码变“坏”。既然没有时间实现，那何必要让它存在呢？

好注释之放大

注释可以用来放大一些看起来不合理的事情，这里有必要说下对于名称的命名，命名时我们要以它要做到的功能为主要参考去命名，不要过多的叙述它的逻辑等，这样会让它变得过长，读代码时产生厌烦感。如果逻辑不好表述，我们可以通过重构抽出代码，在方法名上加以叙述等。增加注释肯定是最后才考虑的。

坏代码之循规式注释

在该需要注释的地方添加注释，不要为了遵循规矩而在规矩之内的地方添加注释。

坏代码之注释掉的代码

千万别这么做，哈哈，我之前写代码，有时候就有这个习惯，修改了某个功能后，有一些代码舍不得删，总觉得以后没准还能用的上（比如用来参考）。以后改掉这个坏习惯。嘿嘿

坏代码之非本地信息

这个的意思是说，写注释时一定要阐述离它最近的代码，不要阐述与最近的代码无关的内容，其它的内容应在其它地方去考虑

小总结

在写程序时，注释是能不写就不写的，我们要尽量用代码去阐述清楚我们的思想，写注释一定要谨慎，注意以上总结的观点。我们依然要坚持一个思想，怎么写着能让人更快的读懂你的程序就怎么写（重点在与快）。