构建 NuGet 包时如何向函数添加文档
How to add documentation to a function when building a NuGet package
我正在为工作构建一个内部 NuGet 包，我想让它尽可能易于使用。
如何在 NuGet 包中包含公开方法的函数定义和描述？
我想要类似的东西：
我是否需要在我的程序包中添加一些内容来提供该功能的详细信息？
额外加分解释如何使用 Nuget 包资源管理器工具来完成它。
此类文档是通过 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 应该能够为您提供一些关于这些的智能感知。
构建包时，启用生成 XML 文档选项，并将生成的 XML 文件包含在 nuspec 文件中，如以下问题所述：How do you include Xml Docs for a class library in a NuGet package?
我正在为工作构建一个内部 NuGet 包，我想让它尽可能易于使用。
如何在 NuGet 包中包含公开方法的函数定义和描述？
我想要类似的东西：
我是否需要在我的程序包中添加一些内容来提供该功能的详细信息？
额外加分解释如何使用 Nuget 包资源管理器工具来完成它。
此类文档是通过 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 应该能够为您提供一些关于这些的智能感知。
构建包时，启用生成 XML 文档选项，并将生成的 XML 文件包含在 nuspec 文件中，如以下问题所述：How do you include Xml Docs for a class library in a NuGet package?