千萬要避免的五種程式註釋方式

　　你是否有過複查程式時發現有些註釋毫無用處？程式註釋是為了提高程式碼的可讀性，為了讓原作者以外的其他開發人員更容易理解這段程式。

　　我把這些讓人鬱悶的註釋方式歸為了五類，同時把寫出這些註釋的程式設計師也歸為了五類。我希望讀了這篇文章後你感覺自己不屬於其中的任何一種型別。如果你有興趣的話可以讀一下另外一篇文章 五種程式設計師(英文)，和這篇講到的五種程式設計師對比一下。

　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
     }
}

　　這種程式設計師是如此的欣賞自己的程式，以至於不得不在每行程式碼上都署上自己的大名。應該讓版本控制系統來提供程式變更的資訊，他這樣做一眼看去並不能說明誰對這行程式碼負責。

　2. 過時的程式設計師

public class Program
{
     static void Main(string[] args)
     {
         /* 這段程式已經不再有用
         * 因為我們發現千年蟲問題只是一場虛驚
         * 我們的系統不會恢復到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);
         //}
     }
}

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

　3. 天真的程式設計師

public class Program
{
     static void Main(string[] args)
     {
         /* 這個程式是用來在螢幕上
         * 迴圈列印1百萬次”I Rule!”
         * 每次輸出一行。迴圈計數
         * 從0開始，每次加1。
         * 當計數器等於1百萬時，
         * 迴圈就會停止執行*/

        for (int i = 0; i < 1000000; i++)
         {
             Console.WriteLine(“I Rule!”);
         }
     }
}

　　基本的程式設計語法規則我們大家都知道——我們不需要“程式設計入門”。你不需要浪費時間來解釋一個顯而易見的東西，我們更希望知道的是你的程式功能——那是浪費空間了。

　4. 傳奇的程式設計師

public class Program
{
     static void Main(string[] args)
     {
        /* 有一天我在大街上的一家星巴克裡
        * 和銷售部的Jim討論問題，他告訴我
        * 銷售代表是依據以下的比例提取佣金的。
        * 週五: 25%
         * 週三: 15%
         * 其它日期: 5%
         * 我是否告訴你過我點了一個卡拉梅
        * 鐵咖啡和兩份的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;
     }
}

　　如果你不得不在註釋裡寫明需求，那也不要提到人名。銷售員Jim很可能在公司裡不再是銷售。而且大多數讀到這段註釋的程式設計師未必都知道Jim是誰。你描述的是實際情況但跟我們的內容不相干，所以就省掉吧。

　5. 未來程式設計師

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這本書。這是我推薦給所有程式設計師必讀的六本書中的一種。或者你可以學學如何停止註釋你的程式(英文)。

　　你是否在你的程式裡還見到過其它種沒有意義的或討厭的註釋？歡迎共享

　　英文原文：LINK