C# Nuget-我在哪里发布文档
当通过Nuget发布包时,特别是SDK—发布文档的最佳实践是什么(例如api参考)?C# Nuget-我在哪里发布文档,c#,visual-studio,nuget,C#,Visual Studio,Nuget,当通过Nuget发布包时,特别是SDK—发布文档的最佳实践是什么(例如api参考)? i、 e-在发布过程中是否有特定的位置可以上载文档,还是应该仅在Git中上载文档?您需要包含一个xml文件- 在创建NuGet包之前,需要先打包一些东西。至少您需要一个已编译的程序集(.dll)供用户参考,但还应该包括一个文档文件(.xml)。您可以创建不包含文档文件的NuGet包,但这样用户就看不到您负责地在代码中包含的许多有用的方法/类/参数注释 对于简单的API参考,通常的做法是NuGet包中的文件 对于
i、 e-在发布过程中是否有特定的位置可以上载文档,还是应该仅在Git中上载文档?您需要包含一个xml文件- 在创建NuGet包之前,需要先打包一些东西。至少您需要一个已编译的程序集(.dll)供用户参考,但还应该包括一个文档文件(.xml)。您可以创建不包含文档文件的NuGet包,但这样用户就看不到您负责地在代码中包含的许多有用的方法/类/参数注释
对于简单的API参考,通常的做法是NuGet包中的文件
对于完整的文档,最好的地方是NuGet之外。就我个人而言,对于我的SDK,我将CHM上传到github上的发布页面。从技术上讲,您可以在包中包含您想要的所有内容,但很少有用户会在包中发现文档,对于大多数用户来说,它只会增加包的大小而没有任何价值。github pages?????您可以使用所有方法,例如设置类似的网站。NuGet本身并没有给你这样做的方法。