Posted on 2006-10-25 15:05
Tauruser 閱讀(1603)
評論(0) 編輯 收藏 引用
C# 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。