我正在构建一个内部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?
