documentation-generation - 如何使用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具有带有src和files属性的exclude对象。

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

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