導讀：注釋?zhuān)臼翘岣叽a可讀性、讓其他開(kāi)發(fā)人員更快速地理解程序的，然而一些無(wú)意義的注釋會(huì )讓人郁悶至極。本文是國外網(wǎng)站GreaterGeek上的一篇文章，作者通過(guò)分類(lèi)介紹了五種一定要避免的程序注釋方式。

全文如下：

你是否有過(guò)復查程序時(shí)發(fā)現有些注釋毫無(wú)用處？程序注釋是為了提高代碼的可讀性，為了讓原作者以外的其他開(kāi)發(fā)人員更容易理解這段程序。

我把這些讓人郁悶的注釋方式歸為了五類(lèi)，同時(shí)把寫(xiě)出這些注釋的程序員也歸為了五類(lèi)。我希望讀了這篇文章后你感覺(jué)自己不屬于其中的任何一種類(lèi)型。如果你有興趣的話(huà)可以讀一下另外一篇文章 五種程序員（英文），和這篇講到的五種程序員對比一下。

1. 高傲的程序員

    
public class Program      
{      
    static void Main(string[] args)      
    {      
        string message = “Hello World!”;  // 07/24/2010 Bob      
        Console.WriteLine(message); // 07/24/2010 Bob      
        message = “I am so proud of this code!”; // 07/24/2010 Bob      
        Console.WriteLine(message); // 07/24/2010 Bob      
    }      
}  

這種程序員是如此的欣賞自己的程序，以至于不得不在每行代碼上都署上自己的大名。應該讓版本控制系統來(lái)提供程序變更的信息，他這樣做一眼看去并不能說(shuō)明誰(shuí)對這行代碼負責。

2. 過(guò)時(shí)的程序員

    
public class Program      
{      
    static void Main(string[] args)      
    {      
        /* 這段程序已經(jīng)不再有用     
         * 因為我們發(fā)現千年蟲(chóng)問(wèn)題只是一場(chǎng)虛驚      
         * 我們的系統不會(huì )恢復到1/1/1900 */     
        //DateTime today = DateTime.Today;      
        //if (today == new DateTime(1900, 1, 1))      
        //{      
        //    today = today.AddYears(100);      
        //    string message = “The date has been fixed for Y2K.”;      
        //    Console.WriteLine(message);      
        //}      
    }      
}  

如果一段程序不再有用（比如廢棄了），那就刪了它吧——不要被幾行沒(méi)用的注釋搞的程序混亂不堪。即使你可能以后重用這段代碼，你也可以使用版本控制系統，用它把你的程序恢復到以前的樣子。

3. 天真的程序員

    
public class Program      
{      
    static void Main(string[] args)      
    {      
        /* 這個(gè)程序是用來(lái)在屏幕上     
         * 循環(huán)打印1百萬(wàn)次”I Rule!”      
         * 每次輸出一行。循環(huán)計數      
         * 從0開(kāi)始，每次加1。      
         * 當計數器等于1百萬(wàn)時(shí)，      
         * 循環(huán)就會(huì )停止運行*/     
     
        for (int i = 0; i < 1000000; i++)      
        {      
            Console.WriteLine(“I Rule!”);      
        }      
    }      
} 

基本的編程語(yǔ)法規則我們大家都知道——我們不需要“編程入門(mén)”。你不需要浪費時(shí)間來(lái)解釋一個(gè)顯而易見(jiàn)的東西，我們更希望知道的是你的程序功能——那是浪費空間了。

4. 傳奇的程序員

    
public class Program      
{      
    static void Main(string[] args)      
    {      
       /* 有一天我在大街上的一家星巴克里     
        * 和銷(xiāo)售部的Jim討論問(wèn)題，他告訴我      
        * 銷(xiāo)售代表是依據以下的比例提取傭金的。      
        * 周五: 25%      
        * 周三: 15%      
        * 其它日期: 5%      
        * 我是否告訴你過(guò)我點(diǎn)了一個(gè)卡拉梅      
        * 鐵咖啡和兩份的Espresso?       
       */     
        double price = 5.00;      
        double commissionRate;      
        double commission;      
        if (DateTime.Today.DayOfWeek == DayOfWeek.Friday)      
        {      
            commissionRate = .25;      
        }      
        else if (DateTime.Today.DayOfWeek == DayOfWeek.Wednesday)      
        {      
            commissionRate = .15;      
        }      
        else     
        {      
            commissionRate = .05;      
        }      
        commission = price * commissionRate;      
    }      
} 

如果你不得不在注釋里寫(xiě)明需求，那也不要提到人名。銷(xiāo)售員Jim很可能在公司里不再是銷(xiāo)售。而且大多數讀到這段注釋的程序員未必都知道Jim是誰(shuí)。你描述的是實(shí)際情況但跟我們的內容不相干，所以就省掉吧。

5. 未來(lái)程序員

    
public class Program      
{      
    static void Main(string[] args)      
    {      
       //TODO: 將來(lái)我會(huì )修復這個(gè)問(wèn)題 – 07/24/1995 Bob      
       /* 我知道這個(gè)問(wèn)題很難解決而且     
        * 我現在依賴(lài)于這個(gè)Contains函數，但      
        * 我以后會(huì )用一種更有意義，更      
        * 優(yōu)雅的方式打印這段代碼。      
        * 我只是現在沒(méi)時(shí)間。      
       */     
       string message = “An error has occurred”;      
       if(message.Contains(“error”))      
       {      
           throw new Exception(message);      
       }      
    }      
} 

這種注釋是一種集大成者，它包含了上面所說(shuō)的注釋的所有問(wèn)題。TODO注釋在一個(gè)項目最初的開(kāi)發(fā)階段是非常有用的，但這個(gè)注釋看起來(lái)是在好幾年前的產(chǎn)品程序里的——它證明了程序有問(wèn)題。如果程序有問(wèn)題需要解決，馬上解決，不要拖到日后再解決。

如果你寫(xiě)過(guò)這樣的注釋?zhuān)蛘呤悄阏趯ふ乙环N最好的注釋方案，我推薦你讀一讀Steve McConnell寫(xiě)的Code Complete這本書(shū)。這是我推薦給所有程序員必讀的六本書(shū)中的一種?；蛘吣憧梢詫W(xué)學(xué)如何停止注釋你的程序（英文）。

你是否在你的程序里還見(jiàn)到過(guò)其它種沒(méi)有意義的或討厭的注釋?zhuān)繗g迎共享。

原文鏈接：http://www.aqee.net/2010/08/12/5-types-of-comments-to-avoid-making-in-your-code/

英文原文鏈接：http://repeatgeek.com/career/5-types-of-comments-to-avoid-making-in-your-code/