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

Question

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

关于如何将XML文件与DocFX一起使用以生成API文档网站的任何想法？

Answer 1

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

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

---

资料来源： DocFX文档

Answer 2

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

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

例：

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

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