在源程序代碼中加上注釋是優(yōu)秀編程人員應(yīng)該養(yǎng)成的好習慣。C#中添加注釋的方法有多種，不過最有特點的是可以使用XML的格式添加注釋，從而減少了許多復雜的工作，也避免了注釋和說明文件不一致的情況。

1. 常規(guī)注釋方式

（1）單行：以“//”符號開始，任何位于“//”符號之后的本行文字都視為注釋。

（2）多行：以“/*”開始，“*/”結(jié)束。任何介于這兩對符號之間的文字都視為注釋。

2. XML注釋方式

“///”符號是一種特殊的注釋方式，只要在用戶自定義的類型如類、接口或者類的成員上方，或者命名空間的聲明上方加上注釋符號“///”，系統(tǒng)就會自動生成對應(yīng)的XML標記。例如：

/// <summary>
        ///
        /// </summary>
       /// <param name="i"></param>
       /// <param name="j"></param>
       /// <returns></returns>

public int Add(int i,int j)
       {
               return i + j;
       }

注意，使用XML注釋方式時，為了讓系統(tǒng)自動生成對應(yīng)的注釋標記，應(yīng)該先編寫方法，然后再在方法名的上方輸入“///”，否則不會自動生成對應(yīng)的參數(shù)注釋等標記。

生成注釋標記后，就可以在<summary>和</summary>之間添加方法的描述，在<param>和</param>之間添加參數(shù)的描述，在<returns>和</returns>之間添加返回值的描述。以后調(diào)用此方法時就可以在鍵入方法名和參數(shù)的過程中直接看到注釋的內(nèi)容。

下表是C#定義的XML注釋元素的標記。

XML注釋標記