什么是docFX?

DocFX 是一个基于.NET的API文档生成器，当前支持 C# 和 VB。

它可以通过你的代码中的三斜杠注释生成 API 参考文档。同样也支持你使用 Markdown 文件创建一些其他的主题文档（例如：教程以及使用手册）。以及自定义生成的参考文档。

DocFX 会使用你的代码以及 Markdown 文件生成一个静态的 HTML 网站。你可以将它轻松的部署到任何web 服务器（例如： github.io）。同样的 DocFX 也提供扩展性，允许你通过模版自定义网站的布局和样式.

 

特性

• 和你的代码紧密集成。你可以在文档中点击 "View Source" 链接导航到github上对应的源代码(你的代码必须发布到 GitHub )。
• 跨平台的支持。拥有Windows平台以及.NET Core 的跨平台 exe程序。
• 和Visual Studio集成. 你可以在Visual Studio 中无缝使用 DocFX 。
• Markdown 扩展。我们推荐DocFX Flavored Markdown(DFM) 格式来编写文档。 DFM 100% 兼容 GitHub Flavored Markdown(GFM) 并且添加了一些有用的扩展,例如 file inclusion（ 文件包含）, code snippet（ 代码片段）, cross reference（ 交叉引用）, 以及 yaml header。

安装docFX

DocFX ships as a chocolatey package. Install docfx through Chocolatey by calling cinst docfx -y.

翻译一下： DocFX 被打包成 chocolatey 包.可以通过 Chocolatey 调用命令 cinst docfx -y 来安装。(这种安装方法俺不会，说的太模糊)。

官网还有一种方法

you can download and unzip docfx.zip from , extract it to a local folder, and add it to PATH so you can run it anywhere.

这个方法还行吧，我就用的这个但是我去这个网址下载这个文件下了好几次才成功，也不知道为啥，最后我越狱下载就成功了。

下载成功就解压呗，然后运行 docfx.exe文件，立马弹出一个命令窗口，然后就立马消失。靠我试了好几遍 都是这个样的，有没有搞错，浪费了我不少时间。

最后我决定把这个程序加载到 环境变量中去，cmd运行 ，ok了 ，安装成功。