C# 註釋

Fode發表於2019-06-23

為了使用C#提供的XML註釋功能,你的註釋應該使用特殊的註釋語法(///)開頭。在///之後,你可以使用預先定義的標籤註釋你的程式碼,也可以插入你自己定義的標籤。你定製的標籤將會在隨後加入到生成的註釋文件中。

 預定義的標籤 用處

<c> 將說明中的文字標記為程式碼
<code> 提供了一種將多行指示為程式碼的方法
<example> 指定使用方法或其他庫成員的示例
<exception> 允許你指定可能發生的異常類
<include> 允許你引用描述原始碼中型別和成員的另一檔案中的註釋, 使用 XML XPath 語法來描述你的原始碼中的型別和成員。
<list> 向XML註釋文件中插入一個列表
<para> 向XML註釋文件中插入一個段落
<param> 描述一個引數
<paramref> 提供了一種指示一個詞為引數的方法
<permission> 允許你將成員的訪問許可加入到文件中
<remarks> 用於新增有關某個型別的資訊
<returns> 描述返回值
<see> 指定連結
<seealso> 指定希望在“請參見”一節中出現的文字
<summary> 型別或型別成員的通用描述
<value> 描述屬性