nuget - 如何使用 NuGet 文档部分？

Question

最近，我看到 NuGet 包页面包含一个文档部分:

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

作为docs似乎没有包含任何关于该项目如何工作的提示，我在这里问:我如何为将出现在该部分中的 NuGet 包提供(大概)包文档？(你能指出说明文档在 NuGet 包网站上的样子的任何示例包？)

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

Answer 1

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

不，此部分仅在您从 NuGet 网站手动配置时显示。见下图(取 self 之前上传的一个包):

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