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

　　注释，本是提高代码可读性、让其他开发人员更快速地理解程序的，然而一些无意义的注释会让人郁闷至极。本文是国外网站GreaterGeek上的一篇文章，作者通过分类介绍了五种一定要避免的程序注释方式。

　　全文如下：

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

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

　　1. 高傲的程序员

　　1. public class Program

　　2. {

　　3. static void Main(string[] args)

　　4. {

　　5. string message = “Hello World!”; // 07/24/2010 Bob

　　6. Console.WriteLine(message); // 07/24/2010 Bob

　　7. message = “I am so proud of this code!”; // 07/24/2010 Bob

　　8. Console.WriteLine(message); // 07/24/2010 Bob

　　9. }

　　10. }

　　这种程序员是如此的欣赏自己的程序，以至于不得不在每行代码上都署上自己的大名。应该让版本控制系统来提供程序变更的信息，他这样做一眼看去并不能说明谁对这行代码负责。

　　2. 过时的程序员

　　1. public class Program

　　2. {

　　3. static void Main(string[] args)

　　4. {

　　5. /* 这段程序已经不再有用

　　6. * 因为我们发现千年虫问题只是一场虚惊

　　7. * 我们的系统不会恢复到1/1/1900 */

　　8. //DateTime today = DateTime.Today;

　　9. //if (today == new DateTime(1900, 1, 1))

　　10. //{

　　11. // today = today.AddYears(100);

　　12. // string message = “The date has been fixed for Y2K.”;

　　13. // Console.WriteLine(message);

　　14. //}

　　15. }

　　16. }

　　如果一段程序不再有用(比如废弃了)，那就删了它吧——不要被几行没用的注释搞的程序混乱不堪。即使你可能以后重用这段代码，你也可以使用版本控制系统，用它把你的程序恢复到以前的样子。

　　3. 天真的程序员

　　1. public class Program

　　2. {

　　3. static void Main(string[] args)

　　4. {

　　5. /* 这个程序是用来在屏幕上

　　6. * 循环打印1百万次”I Rule!”

　　7. * 每次输出一行。循环计数

　　8. * 从0开始，每次加1。

　　9. * 当计数器等于1百万时，

　　10. * 循环就会停止运行*/

　　11.

　　12. for (int i = 0; i < 1000000; i++)