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

Question

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

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

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

Answer 1

在docfx.json中，有一个metadata. 该示例metadata具有一个具有和属性的src对象。filesexclude

要指向解决方案中的另一个项目，请添加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": { ... }
}