在源程序代碼中加上注釋是優秀編程人員應該養成的好習慣。C#中添加注釋的方法有多種,不過最有特點的是可以使用XML的格式添加注釋,從而減少了許多復雜的工作,也避免了注釋和說明文件不一致的情況。
1. 常規注釋方式
(1)單行:以“//”符號開始,任何位于“//”符號之后的本行文字都視為注釋。
(2)多行:以“/*”開始,“*/”結束。任何介于這兩對符號之間的文字都視為注釋。
2. XML注釋方式
“///”符號是一種特殊的注釋方式,只要在用戶自定義的類型如類、接口或者類的成員上方,或者命名空間的聲明上方加上注釋符號“///”,系統就會自動生成對應的XML標記。例如:
/// <summary>
///
/// </summary>
/// <param name="i"></param>
/// <param name="j"></param>
/// <returns></returns>
public int Add(int i,int j)
{
return i + j;
}
注意,使用XML注釋方式時,為了讓系統自動生成對應的注釋標記,應該先編寫方法,然后再在方法名的上方輸入“///”,否則不會自動生成對應的參數注釋等標記。
生成注釋標記后,就可以在<summary>和</summary>之間添加方法的描述,在<param>和</param>之間添加參數的描述,在<returns>和</returns>之間添加返回值的描述。以后調用此方法時就可以在鍵入方法名和參數的過程中直接看到注釋的內容。
下表是C#定義的XML注釋元素的標記。
XML注釋標記
標簽 |
說明 |
<code>……</code> |
程序代碼 |
<example>……</example> |
程序范例 |
<exception>……</exception> |
異常描述 |
<list type="…">……</list> |
添加清單項目 |
<parm name="name"> |
描述方法的參數 |
<para>……</ para > |
代表段落 |
<remark>……</ remark > |
描述詳細信息 |
<returns>……</returns> |
方法的返回值 |
<seealso cref="member"> |
參考到其他說明 |
<permission>……</ permission > |
成員的存取權限 |
<summary>……</ summary > |
簡短的描述 |
<value>……</value> |
描述屬性 |
新聞熱點
疑難解答