用docfx生成c#项目API的简洁教程

1. 下载docfx https://github.com/dotnet/docfx

2. 在环境变量的Path下面添加下载解压后docfx.exe的目录

3. 创建文档项目文件夹(名称如doc),位置最好是在解决方案文件夹,这样目录好配置,其它也方便。

4. 在doc文件夹运行cmd,或打开cmd,进入到doc文件夹

5. 运行docfx init,然后根据提示简单配置一下。网上搜的-q好像是过时了吧。

6. 运行docfx docfx.json。

7. 运行docfx serve _site

8. 浏览器http://localhost:8080

如果生成的不对,检查一下docfx.json里面的"metadata"下"src",还不对的话,再检查下别的。

posted @ 2024-06-03 14:26  水色天空  阅读(6)  评论(0编辑  收藏  举报