注释不是写的越多越好，相反，注释过多反而说明代码存在一定的问题，应该尝试消除代码的问题而不是花费大量的篇幅去解释它。

优秀的注释并不会花费很长时间，下面给出几个建议：

用 伪代码 编程法减少编程时间

在写代码之前，通常需要一定的设计。将设计的一些过程记录在纸面上，根据这些过程去编程，将这些过程变成注释，然后在下面填充实现代码，那么之前的设计就自动变成了注释，这样得到的注释既简洁又高效（伪代码编程是一种很好的实践，关于伪代码编程后续会单独写一篇）。

随时写注释，而不是后补

如果在所有程序都编完以后再补注释，那么大部分人都会很反感，仿佛注释变成了一个额外的工作。在更极端的情况下，在项目快完成时才写注释，那工作量绝对会让人望而却步，然后就会放弃写注释，最后，注释被残忍的抛弃，后期维护痛苦不堪。

好好使用你的 ide

有很多注释，比如文件头的版权说明，作者标记等，都可以通过设置一个模板来解决，建完模板以后再新建文件，这些内容就已经填好了，不再需要额外处理。

还有一些注释，比如 javadoc ，ide都会有一些快捷键或者一些快捷用法来支持，不需要自己再写一遍了。

注意注释风格

不要用那些写起来很麻烦的注释风格，或者自造一个看起来花里胡哨的注释风格，比如：

// item------------每一项
// index-----------索引
 

这种注释可能看起来很好看，但是改起来就非常麻烦了，还需要注意对齐。还比如这样：

//****************************************************
//** 模块AAA **
//****************************************************
 

这个注释也是看起来很好看，但是除了好看一无是处。要说明这部分是一个模块，相对于这样复杂的注释，还不如将整个模块抽离出去，放到一个另外的文件夹。

下面还有一些具体的注释技术：

别用 缩略语

有的代码可能限于篇幅，会用一些缩略语（最好也别这么干，尤其是拼音首字母缩写，真的猜不出来是什么！），但是注释中就不要再加任何的缩略语了，除非一些大家都知道的事情。业务上的缩略语即使大家都知道也最好不要用，因为现在大家都知道，来了一个新人就不一定知道了，他在维护的时候就会一头雾水。

不要注释投机取巧的代码，或者是”巧妙”设计的代码

代码需要一些”技巧”才能工作时，通常说明代码存在缺陷，或者是设计存在问题，真正好的设计都是显而易见的，一看就懂的。所以，不要写”聪明”的代码，而是要尝试修改设计。

不要在每个 子程序 上面都加一大堆注释

每个子程序都应该可以用一两句话说清楚，如果说不清楚，那么就要研究一下是不是设计出了问题。在每个子程序上面加一大堆注释，不仅没什么用，还会让代码文件看起来杂乱不堪，想找什么都找不到。

注释应该靠近其说明的代码

接上一条，如果在子程序的头部大量注释，那么很容易导致注释距离实际代码太远，光看注释不知道在说什么，光看代码也不知道在干什么，这样的注释还不如没有。

多用javadoc之类的工具

现代语言大部分都应该有类似的注释工具，要好好了解并使用。大家都用同一风格的注释会让维护变得更加简单。

注释有关的内容就全部说完了，想要了解更详细的内容大家可以看一看《代码大全》《 代码整洁之道 》，里面有更加详细的内容，感谢阅读！