如何使用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带files和exclude属性的对象.

要指向解决方案中的另一个项目,请向其添加cwd属性metadata并更改文件夹(即"../Another.Project").

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