C#XML文檔註釋

XML文檔

C#可以根據特定的註釋自動創建XML格式的文檔說明。
這些註釋都是單行註釋，但都以三條斜槓開頭

編譯器識別的標記

標記	說明
<C>	把行中的文本標記爲代碼，例如<c>int i=10;</c>
<code>	把多行標記爲代碼
<example>	標記爲代碼示例
<exception>	說明一個異常類
<include>	包含其他文檔說明文件的註釋
<list>	把列表插入文檔中
<para>	建立文本的結構
<param>	標記方法的參數
<paramref>	表明一個單詞是方法的參數
<permission>	說明對成員的訪問
<remarks>	給成員添加描述
<returns>	說明方法的返回值
<see>	提供對另一參數的交叉引用
<seealso>	提供描述中的參見部分
<summary>	提供類型或成員的簡短描述
<typeparam>	用在泛型類型的註釋中，以說明一個類型參數
<typepararef>	類型參數的名稱
<value>	描述屬性

添加XLM註釋的方法

在要註釋內容的上一行點擊三次“/”(要在英文輸入的模式下)編譯器會自動添加註釋內容，如果還是添加不上，在vs下點擊工具->選項->文本編輯器->C#->高級->(勾選)爲///生成XLM文檔註釋

/// <summary>
/// 這裏添加函數說明描述
/// </summary>
/// <param name="a">這裏添加參數說明描述</param>
/// <param name="b">這裏添加參數說明描述</param>
/// <returns>這裏添加返回值說明描述</returns>

添加XLM註釋的例子

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace XML文檔
{
    class Program
    {
        static void Main(string[] args)
        {
            int A = 1;
            int B = 2;
            Add(A, B);
        }
        /// <summary>
        /// 計算兩個整數的和
        /// </summary>
        /// <param name="a"></param>
        /// <param name="b"></param>
        /// <returns>返回a，b的和</returns>
        static int Add(int a, int b)
        {
            a = a + b;
            return a;
        }
    }
}