如何在构建NuGet包时向函数添加文档

Question

我正在为工作构建一个内部NuGet包，我想让它尽可能易于使用。

如何在NuGet包中包含公开方法的函数定义和描述？

我要找类似的东西：

我是否需要添加到我的包中以提供该功能的详细信息？

使用Nuget包资源管理器工具解释如何执行此操作的额外要点。

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文档”选项，并将生成的XML文件包含在nuspec文件中，如此问题中所述：How do you include Xml Docs for a class library in a NuGet package?