7

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

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

4

2 回答 2

4

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

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

例子：

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

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

于 2019-08-12T22:49:54.653 回答
2

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

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

资料来源：DocFX 文档

于 2019-04-25T08:28:22.687 回答