代码整洁之道第四章——注释

第四章讲的是注释,有一句话我很喜欢,说的是:"Comments Do Not Make Up for Bad Code."(注释不是对劣质代码的补救)。事实上好的代码即便没有注释也拥有良好的可读性,但恰当的注释会让代码变得更可读、可维护性更高。

什么也比不上放置良好的注释来得有用。什么也不会比乱七八糟的注释更有本事搞乱一个模块。什么也不会比陈旧、提供错误信息的注释更有破坏性。
注释并不像辛德勒的名单。它们并不“纯然地好”。实际上,注释最多也就是一种必须的恶。若编程语言足够有表达力,或者我们长于用这些语言来表达意图,就不那么需要注释-也许根本不需要。

1、注释不能美化糟糕的代码
2、用代码来阐述
3、好注释:

有些注释是必须的,也是有利的。来看看一些我认为值得写的注释。不过要记住,唯一真正好的注释是你想办法不去写的注释。

4、坏注释

大多数注释都属此类。通常,坏注释都是糟糕的代码的支撑或借口,或者对错误决策的修正,基本上等于程序员自说自话。

不要喃喃自语、不要做多余的注释与误导性注释

好的名字比注释更重要
给常量加注释
在类级别使用全局注释来解释所有部分如何工作
团队统一标记
注释应申明代码高层次意图,而非明显细节
不要添加代码的著作信息,git可以干的事情不要交给代码
真正的好注释是你想办法不去写的注释
原文地址:https://www.cnblogs.com/dwx8845/p/14941065.html