使用 DocFX 生成 .Net/Unity项目文档
文档生成工具DocFX， 类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站。
比如我的测试 使用的Unity UGUI 的源代码库！（突然发现 Unity 官方UI 源代码居然也是用了 .editorconfig 项目跟目录下）
在浏览器中 输入： http://localhost:8080/api/
我好奇的是如何生成 Unity相关的文档：
我百度搜索类似的， 发现了一个Unitysdk 有使用：
https://github.com/mapbox/mapbox-unity-sdk
其中的documentation 下有 配置文件
https://github.com/mapbox/mapbox-unity-sdk/blob/develop/documentation/docfx_project/docfx.json
使用docfx 命令
- 下载
https://github.com/dotnet/docfx/releases
- 使用
创建初始项目
docfx init -q
此命令生成一个名为docfx_project的默认项目。
- 生成网站 （每次需要跟新API或者 修改了配置 都要在执行这个命令重新生成）
docfxdocfx_projectdocfx.json --serve
现在你可以访问http://localhost:8080查看生成的网站。使用 -p 端口 可以指定端口。
注意： 不要有中文路径， 特别是在docfx.json 配置中！
我只是 修改了docfx.json 中的：
1 2 3 4 5 6 7 8 9 10 11 12 | "metadata": [ { "src": [ { "src": "src/Unity-Technologies-ui-0155c39e05ca", "files":["**/**.cs"] } ], "dest": "api" }],"build": { |
然后执行生成网站的命令。
配置的路径要和 程序的执行路径要注意啊！
工具的功能肯定不仅如此， 更多配置就自己看吧！
设置Unity项目 也是一样可以正常生成的：
1 2 3 4 5 6 7 8 9 10 11 12 13 | { "metadata": [ { "src": [ { "src": "src/NiuGames", "files":["**/**.cs"] } ], "dest": "api" } ], "build": { |
因为Unity项目中什么都有， 第三方插件等等！
你可以细化具体包含的路径 和 排除的路径！