c# xml 文件注釋
description
描述型別或型別成員。
description：物件的摘要。
description
新增有關某個型別的資訊，從而補充由 所指定的資訊。
description：成員的說明。
description
使用方法或其他庫成員的示例。這通常涉及使用標記。
description：**示例的說明。
指定希望在「請參見」一節中出現的文字。
member：對可以通過當前編譯環境進行呼叫的成員或字段的引用。必須將 member 括在雙引號 (" ") 中。
description
描述泛型型別或方法的單個型別引數。
name：型別引數的名稱。將此名稱用雙引號括起來 (" ")。
description：型別引數的說明。
description
描述方法的單個引數。
name：方法引數名。將此名稱用雙引號括起來 (" ")。
description：引數說明。
description
描述方法的返回值。
description：返回值的說明。
property-description
描述屬性所代表的值。
property-description：屬性的說明。
description
成員的訪問許可權。使用 permissionset 類可以指定對成員的訪問。
member：對可從當前編譯環境中獲取的許可權的引用。必須將 member 括在雙引號 (" ") 中。
description：對成員的訪問的說明。
description
指定哪些異常可能被引發。此標記可用在方法、屬性、事件和索引器的定義中。
member：對可從當前編譯環境中獲取的異常的引用。必須將 member 括在雙引號 (" ") 中。
description：異常的說明。
text
將說明中的文字標記為**。
text：希望將其指示為**的文字。
content
將多行文字指示為**。
content：希望將其指示為**的文字。
從文字內指定鏈結。
member：對可以通過當前編譯環境進行呼叫的成員或字段的引用。應將 member 放在雙引號 (" ") 中。
、分別引用某個引數或某個型別引數。
member：要引用的引數名（型別引數的名稱）。將此名稱用雙引號括起來 (" ")。
content
用於諸如 、或 等標記內，使您得以將段落新增到文字中。
content：段落文字。
term
description
term
description
塊用於定義表或定義列表中的標題行。定義表時，只需為標題中的項提供乙個項。
列表中的每一項都用乙個 塊來描述。建立定義列表時，既需要指定 term 也需要指定 description。但是，對於表、專案符號列表或編號列表，只需為 description 提供乙個項。
列表或表所擁有的 塊數可以根據需要而定。
term：要定義的項，該項將在 description 中定義。
description：專案符號列表或編號列表中的項或者 term 的定義。
除了使用微軟sandcastle的文件生成工具，還可以使用docsbuilder根據程式集和xml注釋文件生成幫助檔案。
docsbuilder還可以通過自定義模板檔案，生成任何想要的文件內容。
docsbuilder主頁：
使用swagger生成API文件
有時候乙份清晰明了的介面文件能夠極大地提高前後端雙方的溝通效率和開發效率。本文將介紹如何使用swagger生成介面文件。swagger本質上是一種用於描述使用json表示的restful api的介面描述語言。swagger與一組開源軟體工具一起使用，以設計 構建 記錄和使用restful web服...
使用API文件生成工具 sphinx
python第三方庫sphinx可以自動化為restful api生成文件，使用步驟如下所示 pip install sphinx mkdir document 配置方式有兩種 可以使用sphinx quickstart命令配置，基本上一路按回車就可以，最後會生成一下檔案和目錄 2.使用 sphin...
apiDoc 生成api文件
安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...