如何在構建NuGet包時將文檔添加到函數中

Question

我正在構建一個用於工作的內部NuGet包，並且我希望儘可能使用它。

如何在NuGet包中包含暴露方法的函數定義和描述？

我要爲類似於這樣：

有什麼我需要添加到我的包提供的功能做什麼這些細節？

加分說明如何使用NuGet包Explorer工具來做到這一點。

Answer 1

這種類型的文檔是通過XML documentation comments添加的。在啓用「生成XML文檔」選項的情況下進行編譯時，會在包含文檔的DLL旁邊創建一個XML文件。您可以將其包含在您的.nuspec文件中，以便將其與您的庫一起分發，Visual Studio將自動提取它。

在您的功能，只是包括在///塊你想要的標籤：

/// <summary> 
/// Returns "Hello World!" 
/// </summary> 
/// <remarks>This function is pretty useless, actually.</remarks> 
public string HelloWorld() 

有許多共同和recommended tags可以使用。 Visual Studio應該能夠給你一些關於這些的Intellisense。

當你正在構建的包，使生成的XML文檔選項，包括在nuspec文件生成的XML文件，在這個問題描述：How do you include Xml Docs for a class library in a NuGet package?