DocFX

DocFX 是一款 API 文档生成器，适用于 .NET，当前支持 C# 和 VB。它从源代码中的三斜线注释生成 API 参考文档。此外，它还允许你使用 Markdown 文件创建其他主题（例如教程和操作方法），并自定义生成的参考文档。DocFX 从源代码和 Markdown 文件构建了一个静态 HTML 网站，可轻松托管在任何 Web 服务器（例如 github.io）上。此外，DocFX 还为你提供了通过模板自定义网站布局和样式的灵活性。如果你有兴趣使用自己的样式创建自己的网站，可以了解如何创建自定义模板来创建自定义模板。

DocFX 还具有以下炫酷功能

• 与源代码集成。你可以在 API 上单击“查看源代码”以导航到 GitHub 中的源代码（源代码必须推送到 GitHub）。
• 跨平台支持。我们有在 Windows 下运行的 exe 版本。它还可以在使用 Mono 的 Linux/macOS 上跨平台运行。
• 与 Visual Studio 集成。你可以使用 Install-Package docfx.console 在 Visual Studio 中无缝使用 DocFX
• Markdown 扩展。我们引入了 DocFX 风格的 Markdown (DFM)，以便你编写 API 文档。DFM 与 GitHub 风格的 Markdown (GFM) 100% 兼容，并具有某些实用扩展，例如文件包含、代码片段、交叉引用和 yaml 标头。有关 DFM 的详细说明，请参阅 DFM。
• VSCode 集成。在 vscode 中安装 docfx 扩展以实时预览内容。