Nuget - 我在哪里发布文档

Question

通过Nuget发布包时，特别是SDK - 发布文档的最佳实践是什么（例如api参考）？ 即 - 是否有一个特定的地方在发布过程中上传文档，或者它应该只在Git中？

Answer 1

您需要包含xml文件 - You can see here

  

在创建NuGet包之前，您需要打包一些东西。至少，您需要一个编译程序集（.dll）供用户引用，但您还应该包含一个文档文件（.xml）。您可以创建不包含文档文件的NuGet包，但是用户将看不到您负责任地包含在代码中的许多有用的方法/类/参数注释。

Answer 2

对于简短的API参考，通常的做法是在NuGet包中的XML documentation文件[s]。

对于完整的文档，最好的地方是在NuGet之外。就个人而言，我的SDK上传CHM到github上的发布页面。从技术上讲，你可以在包中包含你想要的所有内容，但很少有用户会发现那里的文档，而对于大多数用户来说，它只是膨胀包大小而没有任何价值。