千万要避免的五种程序注释方式

你是否有过复查程序时发现有些注释毫无用处？程序注释是为了提高代码的可读性，为了让原作者以外的其他开发人员更容易理解这段程序。

我把这些让人郁闷的注释方式归为了五类，同时把写出这些注释的程序员也归为了五类。我希望读了这篇文章后你感觉自己不属于其中的任何一种类型。如果你有兴趣的话可以读一下另外一篇文章 五种程序员(英文)，和这篇讲到的五种程序员对比一下。

1. 高傲的程序员

public class Program{    static void Main(string[] args)    {       //TODO: 将来我会修复这个问题  07/24/1995 Bob       /* 我知道这个问题很难解决而且        * 我现在依赖于这个Contains函数，但        * 我以后会用一种更有意义，更        * 优雅的方式打印这段代码。        * 我只是现在没时间。       */       string message = “An error has occurred”;       if(message.Contains(“error”))       {           throw new Exception(message);       }    }}
这种注释是一种集大成者，它包含了上面所说的注释的所有问题。TODO注释在一个项目最初的开发阶段是非常有用的，但这个注释看起来是在好几年前的产品程序里的——它证明了程序有问题。如果程序有问题需要解决，马上解决，不要拖到日后再解决。
如果你不幸是生成这些类型注释的人，或者你想学习注释用法的最佳实践，我推荐你阅读Steve McConnell写的Code Complete（《代码大全》）。这是一本我建议程序员必读的书籍，CSDN 地址 http://blog.csdn.net/justjavac/article/details/7865418。
你是否在自己的代码中看到了其它类型多余或扰人的注释？请不吝分享。
3楼coffeescript昨天 16:12
对号入座：我是【未来的程序员】
2楼looovers昨天 15:02
天才的程序员
1楼ahao214昨天 14:03
我不属于这些程序员。

我的异常网推荐解决方案：程序员的一天,http://www.myexception.cn/other/1391144.html