如何使用NuGet文档部分？

Question

最近，我看到NuGet包页面包含文档部分：

在我检查的所有套餐中，该部分的唯一内容是看似可扩展的显示更多项目，在展开时，显示运动没有更多内容。

由于docs似乎没有包含任何有关该项目如何工作的提示，我在这里问：如何为NuGet包提供（大概）包文档，该文档将显示在部分？（你能否指出任何示例包，说明NuGet包网站上的文档是什么样的？）

值得注意的是，我的软件包包含文档注释中C＃编译器生成的文档XML文件。然而，文档部分中没有任何内容显示，因此不会出现在那里。

Answer 1

您提到的部分位于Nuget.org上的特定包页面上。例如，在RestSharp package page上，这会显示页面顶部附近的文档。本节与任何包数据/详细信息无关。我指出了RestSharp，因为这个软件包附带了一个readme.txt文件（在安装该软件包后显示）。我最初认为它可能与readme.txt file有关。但是，不是！

不，此部分仅在您从NuGet网站手动配置时显示。请参阅下面的图片（取自我之前上传的套餐）：

您可以手动添加文本，将网站定向到文件或直接上传文件。它采用降价格式。