**
/// 會(huì)被編譯,
// 不會(huì)被編譯.
**
所以使用///會(huì)減慢編譯的速度(但不會(huì)影響執(zhí)行速度)
///會(huì)在其它的人調(diào)用你的代碼時(shí)提供智能感知
///也是一種注釋?zhuān)沁@種注釋主要有兩種作用:
1.這些注釋能夠生成一個(gè)XML文件。這樣呢,看起來(lái)會(huì)對(duì)程序的內(nèi)容一目了然。
2.以這種方式對(duì)你的類(lèi),屬性,方法等等加上注釋之后,當(dāng)你在其他地方使用以這種方式加上的類(lèi),屬性,方法等等地時(shí)候,黃色的提示框里面會(huì)把你寫(xiě)的注釋顯示出來(lái),是你更加明白你要使用的功能的作用。
/// <summary>
///定義用戶(hù)姓名屬性,該屬性為可讀可寫(xiě)屬性
/// </summary>
C# Coding的時(shí)候,常常涉及代碼注釋?zhuān)R?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í)注釋
<remarks>對(duì)類(lèi)型進(jìn)行描述,功能類(lèi)似<summary>,據(jù)說(shuō)建議使用<remarks>;
<summary>對(duì)共有類(lèi)型的類(lèi)、方法、屬性或字段進(jìn)行注釋?zhuān)?/p>
<value>主要用于屬性的注釋?zhuān)硎緦傩缘闹频暮x,可以配合<summary>使用;
<param>用于對(duì)方法的參數(shù)進(jìn)行說(shuō)明,格式:<param name="param_name">value</param>;
<returns>用于定義方法的返回值,對(duì)于一個(gè)方法,輸入///后,會(huì)自動(dòng)添加<summary>、<param>列表和<returns>;
<exception>定義可能拋出的異常,格式:<exception cref="IDNotFoundException">;
<example>用于給出如何使用某個(gè)方法、屬性或者字段的使用方法;
<permission>涉及方法的訪問(wèn)許可;
<seealso>用于參考某個(gè)其它的東東:),也可以通過(guò)cref設(shè)置屬性;
<include>用于指示外部的XML注釋?zhuān)?br> II 二級(jí)注釋
<c> or <c o d e>主要用于加入代碼段;
<para>的作用類(lèi)似HTML中的<p>標(biāo)記符,就是分段;
<pararef>用于引用某個(gè)參數(shù);
<see>的作用類(lèi)似<seealso>,可以指示其它的方法;
<list>用于生成一個(gè)列表;
另外,還可以自定義XML標(biāo)簽
二、讓C#智能注釋時(shí)顯示為換行
在C#智能注釋時(shí),常常希望它能在開(kāi)發(fā)時(shí)顯示為換行,使得提示更加友好!原來(lái)一直想怎么實(shí)現(xiàn),今天偶然發(fā)現(xiàn)原來(lái)如此簡(jiǎn)單,只需將<para> 標(biāo)記用于諸如 <summary>、<remarks> 或 <returns> 等標(biāo)記內(nèi)即可。
注釋在開(kāi)發(fā)時(shí)換行顯示的辦法
<para> 標(biāo)記用于諸如 <summary>、<remarks> 或 <returns> 等標(biāo)記內(nèi),使您得以將結(jié)構(gòu)添加到文本中。
/// <summary>
/// 基類(lèi)(第1行)
///<para>說(shuō)明:(第2行)</para>
///<para> 封裝一些常用的成員(第3行)</para>
///<para> 前面要用全角空格才能顯示出空格來(lái)(第4行)</para>
/// </summary>
public class MyBase
{
/// <summary>
/// 構(gòu)造函數(shù)(第1行)
///<para>說(shuō)明:(第2行)</para>
///<para> 初始化一些數(shù)據(jù)(第3行)</para>
/// </summary>
public MyBase()
{
//
//TODO: 在此處添加構(gòu)造函數(shù)邏輯
//
}
}
