**
/// 會被編譯,
// 不會被編譯.
**
所以使用///會減慢編譯的速度(但不會影響執行速度)
///會在其它的人調用你的代碼時提供智能感知
///也是一種注釋,但是這種注釋主要有兩種作用:
1.這些注釋能夠生成一個XML文件。這樣呢,看起來會對程序的內容一目了然。
2.以這種方式對你的類,屬性,方法等等加上注釋之后,當你在其他地方使用以這種方式加上的類,屬性,方法等等地時候,黃色的提示框里面會把你寫的注釋顯示出來,是你更加明白你要使用的功能的作用。
/// <summary>
///定義用戶姓名屬性,該屬性為可讀可寫屬性
/// </summary>
C# Coding的時候,常常涉及代碼注釋,常見的注釋包括兩類:
1)單行注釋。格式:// Comments
2)多行注釋。格式:/* Comments... */
C#引入了新的XML注釋,即我們在某個函數前新起一行,輸入///,VS.Net會自動增加XML格式的注釋,這里整理一下可用的XML注釋。
XML注釋分為一級注釋(Primary Tags)和二級注釋(Secondary Tags),前者可以單獨存在,后者必須包含在一級注釋內部。
I 一級注釋
<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注釋;
II 二級注釋<c> or <c o d e>主要用于加入代碼段;
<para>的作用類似HTML中的<p>標記符,就是分段;
<pararef>用于引用某個參數;
<see>的作用類似<seealso>,可以指示其它的方法;
<list>用于生成一個列表;
另外,還可以自定義XML標簽
二、讓C#智能注釋時顯示為換行
在C#智能注釋時,常常希望它能在開發時顯示為換行,使得提示更加友好!原來一直想怎么實現,今天偶然發現原來如此簡單,只需將<para> 標記用于諸如 <summary>、<remarks> 或 <returns> 等標記內即可。
注釋在開發時換行顯示的辦法
<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: 在此處添加構造函數邏輯
//
}
}