本章將和大家分享在 Windows 系統上如何搭建 Elasticsearch 的開發環境。話不多說，下麵我們直接進入主題。 一、安裝Java的JDK Elasticsearch 其中最主要的開發語言就是 Java ，所以我們在安裝 Elasticsearch 之前，首先需要安裝的就是 Java 的 ...
在代碼中添加 API 文檔
用戶在使用類庫時，通常需要通過 VS 的 Intellisense 或 F12 反編譯查看 API 的註釋，藉助這些註釋來瞭解如何使用 API。在 C# 源文件中，可以通過編寫由三斜杠表示的特殊註釋欄位，在代碼中建立類庫所需的 API 文檔。註釋欄位包含用於描述其下方代碼塊的 XML 元素，XML 元素為 API 文檔提供了結構化的格式，便於編譯器等工具的解析。例如：
/// <summary>
/// Function does an important thing.
/// </summary>
/// <returns>The result.</returns>
public string DoSomething {}
生成 API 文檔的 XML 文件
GenerateDocumentationFile 屬性控制編譯器是否為庫生成 XML 文檔文件。 將此屬性設置為 true，編譯器將在源代碼中找到包含 XML 標記的所有註釋欄位，並根據這些註釋創建 XML 文檔文件。生成的 XML 文件會放置在與程式集相同的輸出目錄中，並具有相同的文件名（但擴展名為 .xml）。
啟用此選項後，編譯器將為項目中所有聲明為公開可見但且沒有 XML 文檔註釋的成員，生成 CS1591 警告。
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
類庫設定為引用程式集
相較實現程式集（Implementation assemblies），設定類庫為引用程式集（Reference assemblies），可以僅暴露聲明為公開可見的成員，隱藏私有實現。
例如數據結構、介面協議定義的類庫，沒有具體需要載入執行的程式集，適合使用此設定。
發佈類庫
連帶著 XML 文檔文件，與 DLL 一同發佈，兩者需在同一目錄下。
引用 DLL 時即可看到 API 文檔註釋。例如：
//
// 摘要:
// Function does an important thing.
//
// 返回結果:
// The result.
public string DoSomething {}
