C# Coding的時(shí)候，常常涉及代碼注釋?zhuān)Ｒ?jiàn)的注釋包括兩類(lèi)：
1）單行注釋。格式：// Comments
2）多行注釋。格式：/* Comments... */
C#引入了新的XML注釋?zhuān)次覀冊(cè)谀硞€(gè)函數(shù)前新起一行，輸入///，VS.Net會(huì)自動(dòng)增加X(jué)ML格式的注釋?zhuān)@里整理一下可用的XML注釋。
XML注釋分為一級(jí)注釋?zhuān)≒rimary Tags）和二級(jí)注釋?zhuān)⊿econdary Tags），前者可以單獨(dú)存在，后者必須包含在一級(jí)注釋內(nèi)部。
I 一級(jí)注釋
1. <remarks>對(duì)類(lèi)型進(jìn)行描述，功能類(lèi)似<summary>，據(jù)說(shuō)建議使用<remarks>;
2. <summary>對(duì)共有類(lèi)型的類(lèi)、方法、屬性或字段進(jìn)行注釋?zhuān)?/p>
3. <value>主要用于屬性的注釋?zhuān)硎緦傩缘闹频暮x，可以配合<summary>使用；
4. <param>用于對(duì)方法的參數(shù)進(jìn)行說(shuō)明，格式：<param name="param_name">value</param>；
5. <returns>用于定義方法的返回值，對(duì)于一個(gè)方法，輸入///后，會(huì)自動(dòng)添加<summary>、<param>列表和<returns>；
6. <exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
7. <example>用于給出如何使用某個(gè)方法、屬性或者字段的使用方法；
8. <permission>涉及方法的訪(fǎng)問(wèn)許可；
9. <seealso>用于參考某個(gè)其它的東東:)，也可以通過(guò)cref設(shè)置屬性；
10. <include>用于指示外部的XML注釋?zhuān)?/p>
II 二級(jí)注釋
1. <c> or <code>主要用于加入代碼段；
2. <para>的作用類(lèi)似HTML中的<p>標(biāo)記符，就是分段；
3. <pararef>用于引用某個(gè)參數(shù)；
4. <see>的作用類(lèi)似<seealso>，可以指示其它的方法；
5. <list>用于生成一個(gè)列表；
另外，還可以自定義XML標(biāo)簽。
呵呵，通過(guò)在工程的屬性中設(shè)置 XML Documentation File的文件名，即可生成xml格式的文件。
另外還有一個(gè)有用的工具叫NDoc，可以根據(jù)這些注釋生成幫助文件，很好使。但是好像不支持Vs.net 2005。