c#基礎

一、C# 中 // 註釋和 /// 註釋的區別

/// 會被編譯， // 不會

所以使用 /// 會減慢編譯的速度（但不會影響執行速度）

/// 會在其它的人呼叫你的程式碼時提供智慧感知

/// 也是一種註釋，但是這種註釋主要有兩種作用：

• 1.這些註釋能夠生成一個XML檔案。這樣呢,看起來會對程式的內容一目瞭然。
• 2.以這種方式對你的類，屬性，方法等等加上註釋之後，當你在其他地方使用以這種方式加上的類，屬性，方法等等地時候，黃色的提示框裡面會把你寫的註釋顯示出來，是你更加明白你要使用的功能的作用。

/// <summary>
///定義使用者姓名屬性，該屬性為可讀可寫屬性
/// </summary>

C# 編碼的時候，常常涉及程式碼註釋，常見的註釋包括兩類：

• 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標籤

二、讓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: 在此處新增建構函式邏輯 
            // 
       } 
}