在代碼中添加 API 文檔
用戶在使用類庫(kù)時(shí)，通常需要通過(guò) VS 的 Intellisense 或 F12 反編譯查看 API 的注釋，借助這些注釋來(lái)了解如何使用 API。在 C# 源文件中，可以通過(guò)編寫由三斜杠表示的特殊注釋字段，在代碼中建立類庫(kù)所需的 API 文檔。注釋字段包含用于描述其下方代碼塊的 XML 元素，XML 元素為 API 文檔提供了結(jié)構(gòu)化的格式，便于編譯器等工具的解析。例如：
/// <summary>
/// Function does an important thing.
/// </summary>
/// <returns>The result.</returns>
public string DoSomething {}
生成 API 文檔的 XML 文件
GenerateDocumentationFile 屬性控制編譯器是否為庫(kù)生成 XML 文檔文件。 將此屬性設(shè)置為 true，編譯器將在源代碼中找到包含 XML 標(biāo)記的所有注釋字段，并根據(jù)這些注釋創(chuàng)建 XML 文檔文件。生成的 XML 文件會(huì)放置在與程序集相同的輸出目錄中，并具有相同的文件名（但擴(kuò)展名為 .xml）。
啟用此選項(xiàng)后，編譯器將為項(xiàng)目中所有聲明為公開可見但且沒有 XML 文檔注釋的成員，生成 CS1591 警告。
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
類庫(kù)設(shè)定為引用程序集
相較實(shí)現(xiàn)程序集（Implementation assemblies），設(shè)定類庫(kù)為引用程序集（Reference assemblies），可以僅暴露聲明為公開可見的成員，隱藏私有實(shí)現(xiàn)。
例如數(shù)據(jù)結(jié)構(gòu)、接口協(xié)議定義的類庫(kù)，沒有具體需要加載執(zhí)行的程序集，適合使用此設(shè)定。
發(fā)布類庫(kù)
連帶著 XML 文檔文件，與 DLL 一同發(fā)布，兩者需在同一目錄下。文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-711343.html
引用 DLL 時(shí)即可看到 API 文檔注釋。例如：文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-711343.html
//
// 摘要:
// Function does an important thing.
//
// 返回結(jié)果:
// The result.
public string DoSomething {}
參考資料
- C# 指南 - XML 文檔注釋
- 引用程序集
到了這里，關(guān)于C# - 自建 SDK 的 API 文檔的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
