安装DocFX
用于构建和发布.NET项目的API文档的工具
DocFX下载地址(点击下载)
下载docfx.zip解压到心仪目录即可
配置环境
win + R 输入 sysdm.cpl 按Enter,打开系统属性窗口
点击“高级”选项卡下“环境变量”按钮,打开环境变量窗口
点击系统变量下“新建”按钮,输入变量名和变量值(路径),确定
找到系统变量下“Path”双击进入编辑状态,点击“新建”,输入“%DocFX%”(你的变量名),一点击3次确认按钮退出,直至退出“系统属性”窗口。
生成DocFX项目
新建一个目录(DocFX Project目录),用来生成DocFX项目。打开目录,按住 Shift + 鼠标右键 ,打开 Powershell窗口。
docfx init -q:使用此命令在目录下初始一个,生成名为docfx_project的默认 docfx 项目
-q:这个参数表示忽略询问,直接生成。如果需要自定义配置,可取消 -q 这个参数。
docfx_project\src:目录用来存放你需要生成文档的项目,直接把整个项目(解决方案)放进去即可。
docfx.json是docfx用于生成文档的配置文件(按照格式修改)
docfx docfx_project\docfx.json --serve:生成API文档
现在可以通过http://localhost:8080/api/去查看文档
如果未使用端口8080,docfx则将_site在下托管http://localhost:8080。如果8080正在使用,则可以使用docfx serve _site -p 更改要使用的端口docfx。