内容简介：使用 DocFX 生成 .Net/Unity项目文档
孙广东 2017.5.27
http://blog.csdn.NET/u010019717
微软开源全新的文档生成工具 DocFX 类似JSDoc或Sphinx 如何使用看 ：
http://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html
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_project\docfx.json --serve
现在你可以访问http://localhost:8080查看生成的网站。使用 -p 端口 可以指定端口。
注意 ： 不要有中文路径， 特别是在docfx.json 配置中！
我只是 修改了docfx.json 中的：
"metadata": [
{
"src": [
{
"src": "src/Unity-Technologies-ui-0155c39e05ca",
"files":["**/**.cs"]
}
],
"dest": "api"
}
],
"build": {
……………………………………..
然后执行生成网站的命令。
配置的路径要和 程序的执行路径要注意啊！
工具的功能肯定不仅如此， 更多配置就自己看吧！
设置Unity项目 也是一样可以正常生成的：
{
"metadata": [
{
"src": [
{
"src": "src/NiuGames",
"files":["**/**.cs"]
}
],
"dest": "api"
}
],
"build": {
因为Unity项目中什么都有， 第三方插件等等！
你可以细化具体包含的路径 和 排除的路径！
完！
以上所述就是小编给大家介绍的《使用 DocFX 生成 .Net/Unity项目文档》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持！
猜你喜欢:
- 在 Laravel 中集成 API 文档生成器扩展包为 Dingo API 接口生成文档
- 使用Sphinx生成/管理文档
- Java 生成 PDF 文档
- 文档生成器 mkdocs
- Doxygen 3 发布，文档生成工具
- 如何使用 sphinx 来生成代码文档
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
