c# - 如何使用 XML 文档文件生成带有 DocFX 的文档？

Question

我想为 .NET 项目创建类似于 API 文档网站的内容。根据 .NET Docs我们放在方法、类等之上的 XML 注释可以由编译器处理成一个 XML 文件，并且该文件可以通过像 DocFX 这样的工具运行。生成文档网站。 .NET Docs 没有为后者提供任何说明，DocFX 文档也没有给出任何关于如何使用该 XML 文件创建 API 文档网站的提示。

关于如何使用该 XML 文件和 DocFX 生成 API 文档网站有什么想法吗？

Answer 1

如果您使用的是 .NET Core 2.2 或更高版本，您可以更新您的 docfx.json直接从 .dll 中提取元数据和 .xml .

DocFX "will lookup for the XML file in the same folder"具有与 .dll 相同的文件名.

例子:

{
  "metadata": [
    {
      "src": "bin/Release/netstandard2.0/YourCompany.YourNamespace.dll",
      "dest": "obj/api"
    }
  ]
}

您还应该包括 <GenerateDocumentationFile>true</GenerateDocumentationFile>进入你的.csproj文件。