如何使用 NuGet 文档部分？答案

【问题标题】：How can the NuGet Documentation section be used?如何使用 NuGet 文档部分？
【发布时间】：2017-12-04 21:47:41
【问题描述】：

最近，我看到 NuGet 包页面包含一个 Documentation 部分：

不过，在我检查过的所有包中，该部分的唯一内容是一个看似可展开的显示更多项，展开后，它不会显示更多内容。

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

值得注意的是，我的包包含由 C# 编译器从文档 cmets 生成的文档 XML 文件。然而，Documentation 部分中没有显示任何内容，因此这不是应该出现的内容。

【问题讨论】：

【解决方案1】：

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

不，此部分仅在您从 NuGet 网站手动配置时才会显示。见下图（取自我之前上传的一个包）：

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

【讨论】：