如何使用 XML 文档文件使用 DocFX 生成文档？

Question

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

关于如何使用带有 DocFX 的 XML 文件生成 API 文档网站的任何想法？

Answer 1

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

DocFX “将在同一文件夹中查找 XML 文件”文件名相同的XML 文件” .dll。

例子：

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

您还应该将其包含<GenerateDocumentationFile>true</GenerateDocumentationFile>到您的.csproj文件中。

Answer 2

对于任何遇到此问题的人，可以直接在 Visual Studio 2017 及更高版本中使用 DocFX：

• 将 NuGet 包安装docfx.console到包含 XML 文档的项目。
• 构建项目后，_site将在项目.csproj文件所在的同一文件夹中生成一个文件夹。该文件夹包含文档（通过index.html文件访问）。

来源：DocFX 文档