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

时间:2018-12-28 23:51:22

标签: c# .net comments documentation docfx

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

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

2 个答案:

答案 0 :(得分:2)

对于遇到任何困难的人,都可以在Visual Studio 2017和更高版本中直接使用DocFX:

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

来源:DocFX Documentation

答案 1 :(得分: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