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

发布时间：2020-12-15 08:38:06 所属栏目：百科来源：网络整理

导读：我正在构建一个内部NuGet包用于工作,我想让它尽可能易于使用. 如何在NuGet包中包含暴露方法的函数定义和描述？我要找类似的东西：我需要添加到我的包中以提供函数功能的详细信息吗？使用Nuget包资源管理器工具解释如何执行此操作的额外要点. 解决方法此

我正在构建一个内部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应该能够为您提供一些Intellisense.

在构建程序包时,启用“生成XML文档”选项,并将生成的XML文件包含在nuspec文件中,如此问题中所述：How do you include Xml Docs for a class library in a NuGet package?

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!