為了使用C#提供的XML注釋功能,你的注釋應該使用特殊的注釋語法(///)開頭。在///之后,你可以使用預先定義的標簽注釋你的代碼,也可以插入你自己定義的標簽。你定制的標簽將會在隨后加入到生成的注釋文檔中。
預定義的標簽 用處
<c> 將說明中的文本標記為代碼
<code> 提供了一種將多行指示為代碼的方法
<example> 指定使用方法或其他庫成員的示例
<exception> 允許你指定可能發生的異常類
<include> 允許你引用描述源代碼中類型和成員的另一文件中的注釋, 使用 XML XPath 語法來描述你的源代碼中的類型和成員。
<list> 向XML注釋文檔中插入一個列表
<para> 向XML注釋文檔中插入一個段落
<param> 描述一個參數
<paramref> 提供了一種指示一個詞為參數的方法
<permission> 允許你將成員的訪問許可加入到文檔中
<remarks> 用於添加有關某個類型的信息
<returns> 描述返回值
<see> 指定鏈接
<seealso> 指定希望在“請參見”一節中出現的文本
<summary> 類型或類型成員的通用描述
<value> 描述屬性