如何使用 DocFx 为解决方案中的其他项目生成文档

Question

我正在使用 DocFx 在 Visual Studio 2015 年自动生成文档。

根据 Getting Started 说明，我添加了一个空的 ASP.NET 4 Web 应用程序并使用 Nuget 控制台安装 DocFx 构建包（例如 Install-Package docfx.msbuild）。我建立了网站，它为项目中的代码生成了文档。

我想知道如何配置 docfx.json 让 DocFx 记录解决方案中其他项目中的代码。

Answer 1

在docfx.json中，有一个metadata的数组。示例 metadata 有一个具有 files 和 exclude 属性的 src 对象。

要指向解决方案中的另一个项目，请将 cwd 属性添加到 metadata 并更改文件夹（即“../Another.Project”）。

{ "metadata": [ { "src": [ { "files": [ "**/*.csproj" ], "exclude": [ "**/bin/**", "**/obj/**", "_site/**" ], "cwd": "../Another.Project" } ], "dest": "obj/api" } ], "build": ... }

Answer 2

这对我有用。

目录结构

+---ClassLibrary
|   \---ClassLibrary.csproj
\---DocFxProject
    \---docfx.json

docfx.json 内容 cwd 和 src 是同义词属性

{
  "metadata":
  [ 
    {
      "src":
      [
        {
          "files": [ "**/ClassLibrary.csproj" ],
          "src": "..",
          "exclude": [ "**/obj/**", "**/bin/**" ]
        } 
      ],
      "dest": "obj/api"
    }
  ],
  "build": { ... }
}

如何使用 DocFx 为解决方案中的其他项目生成文档

How to generate documentation for other projects within solution using DocFx

documentation-generation

docfx