问题标签 [docfx]

我有文件的结构：

我想使用 DocFX 来创建我的项目的文档，但我的问题是文件 docfx.json。我的项目在另一个文件C:\Test\ConsoleApp1\ConsoleApp1夹中，而不是在 docFx 中的 src 文件夹中，当我尝试更改本地化 docFx 时找不到该项目。如何设置此路径？

我介绍了正确的路径，但仍然无法正常工作。

如何在打字稿中记录联合类型，以便typedoc提取/显示相关信息？下面是一份 JSDoc 参考资料，但是否有 TSDoc 参考资料？

例子

它们只是因为导出而被提取，但没有生成任何信息。( docfx@2.56.6, typedoc@0.19.2, type2docfx@0.10.5)

编辑：有什么方法可以使用上面的工具为这些类型生成文档？

我希望 DoxFX 仅在我选择构建配置“Release+Docs”时生成文档，因为否则会浪费大量时间进行测试。

我已将此行添加到docfx.console.targets，但似乎无效。无论如何都会生成文档。

您如何正确禁用它？

我正在编写一个 C# winforms 应用程序，我想为我的代码创建带有 XML 注释的文档。但是，似乎我做错了什么，无法弄清楚它是什么。目前，为了生成 HTML 文档，我正在使用DocFX（但我也尝试了sandcastle，但结果相同）。创建 XML 文件和 HTML 文档时，它似乎只包含我的主Form1.cs类（这很有趣，因为在那个特定文件中我没有任何 XML 注释）。不包括其他.cs文件（由 XML 注释组成）（它们在整个开发过程中通过 Visual Studio 添加到项目中，右键单击项目 -> 添加 -> 新项目 -> C# 类）。这是我的docfx.json：

而且，我的文件层次结构如下所示：

如何在 XML 创建中包含其他文件？

我创建了一个在 .NET Framework 4.7.2 上运行的新 C# WinForms 项目，我想从 XML 生成的文件创建一个 pdf 文档。我已成功安装 VS docfx.console 包，如此处第 3 项中所述。当我构建我的解决方案时，它会创建_site文件夹index.html, toc.html, ImageArt.html, ImageArt.Form1.html（ImageArt我的项目名称空间在哪里）。但是我在创建的文档（甚至我的 Main 函数）中看不到任何其他类的函数（我使用 XML 注释记录了这些函数）。知道出了什么问题，或者如何将其他类/函数添加到导出的文档中？

编辑： XML 文件通常在 bin/Debug/ 文件夹下生成，如下所示：

如您所见，它包含Main方法和NewClass类的成员项，但在生成的 HTML 文档中缺少它们。

我正在使用 Azure DevOps for CI 开发一个带有 Android 目标的 Xamarin Forms 项目。我的项目在我的本地机器和 Azure Pipeline 中构建良好。现在，我想用 DocFx 生成代码文档。因此，我配置了一个 powershell 脚本来下载 docfx.console 工具并从我的 docfx.json 文件中执行它。该脚本在我的本地机器上运行良好，并且文档已正确生成。

我在 Azure Pipeline 中添加了一个任务来执行我的 powershell 脚本，并且 DocFx 失败并出现 FileNotFoundException 异常，该异常涉及 System.Buffers.dll 文件和以下日志：

我尝试在不进行更改的情况下在 .csproj 文件旁边添加以下 app.config 文件：

信息：

DocFx 版本：2.57.2

Xamarin 表单版本：5.0.0.2012

Azure Pipeline 构建代理：Microsoft 托管的“最新窗口”

我已经设法为 DocFX 安装并进行了基本设置，但我在寻找某些问题的地方遇到了困难。

我想解决的第一个问题是我的 API 文档的 TOC，理想情况下按项目然后命名空间分解。

我可以在我的 API 文件夹的输出中看到带有 toc.yml 的预处理文件，如下所示：

但是当我查看页面时，我得到以下信息：

我的 dofx.json 如下：

这是在 FiveM 中，我不知道如何将其写入“普通”lua。

这是代码：

想在每个页面的源代码中包含一个视图，但不知道在 docfx.json 中更改什么选项来做到这一点。

请指教。

我这里有一个包含 100 多行的降价文件

当我预览降价文档时，导航正常工作

这是我准备导航的地方：

在 markdown 文件中，标头已设置如下：

但是，在我使用docfx pdf将 markdown 文件转换为 pdf 后，getEngineMetadata由于标题位于 pdf 中的其他页面，因此导航无法正常工作。

无论如何编辑降价文件，即使标题不在同一页面中，导航也能正常工作？