C#語言注釋有三種形式
C#語言注釋有三種形式
第一種是多行注釋：
/* */
例如：
/* int a=1;
int b=2;
int c=3;
*/
// 第二種是單行注釋：
例如：
// int d=0;
第三種是文檔注釋
///
例如：
|
1
2
3
4
5
6
7
8
9
10
|
/// <summary>This method changes the point's location by
/// the given x- and y-offsets.
/// <example>For example:
/// <code>
/// Point p = new Point(3,5);
/// p.Translate(-1,3);
/// </code>
/// results in <c>p</c>'s having the value (2,8).
/// </example>
/// </summary>
|
用於類的前面注釋或者方法、屬性前面注釋
c#中//注釋和///注釋的區別 智能注釋 顯示換行
///會被編譯，
//不會
所以使用///會減慢編譯的速度（但不會影響執行速度）
///會在其它的人調用你的代碼時提供智能感知
也是一種注釋，但是這種注釋主要有兩種作用：
1.這些注釋能夠生成一個XML文件。這樣呢,看起來會對程序的內容一目了然。
2.以這種方式對你的類，屬性，方法等等加上注釋之后，當你在其他地方使用以這種方式加上的類，屬性，方法等等地時候，黃色的提示框里面會把你寫的注釋顯示出來，是你更加明白你要使用的功能的作用。
/// <summary>
///定義用戶姓名屬性，該屬性為可讀可寫屬性
/// </summary>
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標簽
注釋在開發時換行顯示的辦法
<para> 標記用於諸如 <summary>、<remarks> 或 <returns> 等標記內，使您得以將結構添加到文本中。
/// <summary>
/// 基類（第1行）
///<para>說明：（第2行）</para>
///<para> 封裝一些常用的成員（第3行）</para>
///<para> 前面要用全角空格才能顯示出空格來（第4行）</para>
/// </summary>
public class MyBase
{
/// <summary>
/// 構造函數（第1行）
///<para>說明：（第2行）</para>
///<para> 初始化一些數據（第3行）</para>
/// </summary>
public MyBase()
{
//
//TODO: 在此處添加構造函數邏輯
//
}
}
