C# 註釋

爲了使用C#提供的XML註釋功能,你的註釋應該使用特殊的註釋語法(///)開頭。在///以後,你能夠使用預先定義的標籤註釋你的代碼,也能夠插入你本身定義的標籤。你定製的標籤將會在隨後加入到生成的註釋文檔中。code

 預約義的標籤 用處rem

<c> 將說明中的文本標記爲代碼
<code> 提供了一種將多行指示爲代碼的方法
<example> 指定使用方法或其餘庫成員的示例
<exception> 容許你指定可能發生的異常類
<include> 容許你引用描述源代碼中類型和成員的另外一文件中的註釋, 使用 XML XPath 語法來描述你的源代碼中的類型和成員。
<list> 向XML註釋文檔中插入一個列表
<para> 向XML註釋文檔中插入一個段落
<param> 描述一個參數
<paramref> 提供了一種指示一個詞爲參數的方法
<permission> 容許你將成員的訪問許可加入到文檔中
<remarks> 用於添加有關某個類型的信息
<returns> 描述返回值
<see> 指定連接
<seealso> 指定但願在「請參見」一節中出現的文本
<summary> 類型或類型成員的通用描述
<value> 描述屬性
文檔

相關文章
相關標籤/搜索