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 二級注釋

  11. <c> or <c o d e>主要用于加入代碼段;

  12. <para>的作用類似HTML中的<p>標記符,就是分段;

  13. <pararef>用于引用某個參數;

  14. <see>的作用類似<seealso>,可以指示其它的方法;

  15. <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: 在此處添加構造函數邏輯
//
}
}

Paste_Image.png
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,247評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,520評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 178,362評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,805評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,541評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,896評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,887評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,062評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,608評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,356評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,555評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,077評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,769評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,175評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,489評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,289評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,516評論 2 379

推薦閱讀更多精彩內容