如何在构建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.

在构建程序包时,启用"生成XML文档"选项,并将生成的XML文件包含在nuspec文件中,如此问题中所述:如何在NuGet包中包含类库的Xml Docs？