[ZT]C#中XML格式注釋
來源:互聯網
上載者:User
coding的時候,常常涉及代碼注釋,常見的注釋包括兩類:
1)單行注釋。格式:// comments
2)多行注釋。格式:/* comments... */
c#引入了新的xml注釋,即我們在某個函數前新起一行,輸入///,vs.net會自動增加xml格式的注釋,這裡整理一下可用的xml注釋。
xml注釋分為一級注釋(primary tags)和二級注釋(secondary tags),前者可以單獨存在,後者必須包含在一級注釋內部。
i 一級注釋
1. <remarks>對類型進行描述,功能類似<summary>,據說建議使用<remarks>;
2. <summary>對共有類型的類、方法、屬性或欄位進行注釋;
3. <value>主要用於屬性的注釋,表示屬性的制的含義,可以配合<summary>使用;
4. <param>用於對方法的參數進行說明,格式:<param name="param_name">value</param>;
5. <returns>用於定義方法的傳回值,對於一個方法,輸入///後,會自動添加<summary>、<param>列表和<returns>;
6. <exception>定義可能拋出的異常,格式:<exception cref="idnotfoundexception">;
7. <example>用於給出如何使用某個方法、屬性或者欄位的使用方法;
8. <permission>涉及方法的訪問許可;
9. <seealso>用於參考某個其它的東東:),也可以通過cref設定屬性;
10. <include>用於指示外部的xml注釋;
ii 二級注釋
1. <c> or <code>主要用於加入程式碼片段;
2. <para>的作用類似html中的<p>標記符,就是分段;
3. <pararef>用於引用某個參數;
4. <see>的作用類似<seealso>,可以指示其它的方法;
5. <list>用於產生一個列表;
另外,還可以自訂xml標籤。
呵呵,通過在工程的屬性中設定 xml documentation file的檔案名稱,即可產生xml格式的檔案。
另外還有一個有用的工具叫ndoc,可以根據這些注釋產生協助檔案,很好使。但是好像不支援vs.net 2005。