c# - 构建 NuGet 包时如何向函数添加文档

Question

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

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

我想要类似的东西：

我需要在我的包中添加一些东西来提供函数功能的详细信息吗？

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

Answer 1

这种类型的文档是通过XML 文档注释添加的。在启用“生成 XML 文档”选项的情况下进行编译时，会在包含该文档的 DLL 旁边创建一个 XML 文件。您可以将其包含在.nuspec文件中以将其与您的库一起分发，Visual Studio 将自动获取它。

在您的功能上，只需在块中包含您想要的标签///：

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

您可以使用许多常见和推荐的标签。Visual Studio 应该能够在这些方面为您提供一些 Intellisense。

在构建包时，启用 Generate XML Documentation 选项，并将生成的 XML 文件包含在 nuspec 文件中，如以下问题所述：如何在 NuGet 包中包含类库的 Xml Docs？