程序员应该避免的5种代码注释

你有没有这样的经历：别人审查过你的代码以后给出的注释，你认为是没有必要的？注释代码是为了提升代码的可读性，目的是为了能让其余人更容易理解你的代码。

我特别讨厌这5种注释类型以及制造它们的程序员。但愿你不是其中之一。更多精彩文章尽在爱开发APP源码论坛

1.自觉得很了不起的程序员

 

这个程序员自认为写了一段很了不起的代码，因此以为有必要用本身的名字对每行代码进行标记。实施版本控制系统（VCS）能实现对代码变动的问责，可是也不会这么明显知道谁应对此负责。

 

 

2.过期的程序员

若是一段代码已再也不使用（即过期），那就删除它——不要浪费时间给这些代码写注释。此外，若是你须要复制这段被删除的代码，别忘了还有版本控制系统，你彻底能够从早期的版本中恢复代码。

 

 

3.画蛇添足的程序员

咱们都知道基础的编程逻辑是如何工做的——因此你不须要画蛇添足来解释这些显而易见的工做原理，虽说你解释得很happy，但这只是在浪费时间和空间。

 

 

4.爱讲故事的程序员

若是你必定要在注释里说起需求，那么不要涉及别人的名字。销售部门的Jim可能会离开公司，并且颇有可能大多数程序员根本不知道这是何许人也。不要在注释里说起不相干的事实。

 

 

5.“之后再作”的程序员

这种类型的注释包含了上面全部其余类型。若是是在项目的初始开发阶段，这种待作注释是很是有用的，但若是是在几年后的产品代码——那就会出问题了。若是有什么须要修复的，立马解决，不要把它搁置一边，“之后再作”。

若是你也经常犯这样的注释错误，若是你想了解注释的最佳作法，我建议你阅读相似于Steve McConnell写的《Code Complete》这样的好书。

另外笔者也推荐你阅读如下内容：《9个最有趣的代码注释》、《代码注释中的5要与3不要》