C#的注釋
一般分為兩類:
1）
單行注釋。格式：// Comments 或者 ///(
XML注釋的一級注釋)
2）
多行注釋。格式：/* Comments... */
c#中//注釋和///注釋的區別
- ///:會被編譯,會減慢編譯的速度（但不會影響執行速度）
- //:不會被編譯,
- 使用///:
- 會在其它的人調用你的代碼時提供智能感知
- 也是一種注釋，但是這種注釋主要有兩種作用：
- 1.這些注釋能夠生成一個XML文件。這樣呢,看起來會對程序的內容一目了然。
- 2.以這種方式對你的類，屬性，方法等等加上注釋之后，當你在其他地方使用以這種方式加上的類，屬性，方法等等地時候，黃色的提示框里面會把你寫的注釋顯示出來，是你更加明白你要使用的功能的作用。
-
XML注釋(///):
- 一級注釋（Primary Tags）:可以單獨存在
- 二級注釋（Secondary Tags）:必須包含在一級注釋內部。
一級注釋:
<remarks> 對類型進行描述，功能類似<summary>，據說建議使用<remarks>;
<summary> 對共有類型的類、方法、屬性或字段進行注釋；
<value>主要用於屬性的注釋，表示屬性的制的含義，可以配合<summary>使用；
<param>用於對方法的參數進行說明，格式：<param name="param_name">value </param>；
<returns>用於定義方法的返回值，對於一個方法，輸入///后，會自動添加<summary>、<param>列表和<returns>；
<exception>定義可能拋出的異常，格式：<exception cref="IDNotFoundException">；
<example>用於給出如何使用某個方法、屬性或者字段的使用方法；
<permission>涉及方法的訪問許可；
<seealso>用於參考某個其它的東東:)，也可以通過cref設置屬性；
<include>用於指示外部的XML注釋；
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注釋；
&&案例:
/// <summary>
///定義用戶姓名屬性，該屬性為可讀可寫屬性
/// </summary>x
1
&&案例:
2
/// <summary>
3
///定義用戶姓名屬性，該屬性為可讀可寫屬性
4
/// </summary>
二級注釋:
<c> or <code>主要用於加入代碼段；
<para>的作用類似HTML中的<p>標記符，就是分段；
<pararef>用於引用某個參數；
<see>的作用類似<seealso>，可以指示其它的方法；
<list>用於生成一個列表；
5
5
1
<c> or <code>主要用於加入代碼段；
2
<para>的作用類似HTML中的<p>標記符，就是分段；
3
<pararef>用於引用某個參數；
4
<see>的作用類似<seealso>，可以指示其它的方法；
5
<list>用於生成一個列表；
另外，還可以自定義XML標簽