目錄

• • XML文檔
  • 編譯器識別的標記
  • 添加XLM注釋的方法
  • 添加XLM注釋的例子

XML文檔

C#可以根據(jù)特定的注釋自動創(chuàng)建XML格式的文檔說明。
這些注釋都是單行注釋，但都以三條斜杠開頭

編譯器識別的標記

標記說明

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

添加XLM注釋的方法

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

/// <summary> /// 這里添加函數(shù)說明描述 /// </summary> /// <param name="a">這里添加參數(shù)說明描述</param> /// <param name="b">這里添加參數(shù)說明描述</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>/// 計算兩個整數(shù)的和/// </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;}} }

總結(jié)

以上是生活随笔為你收集整理的XML文档注释（C#）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。