使用 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项目文档的更多相关文章
- 使用Docfx生成项目文档
使用docfx.console生成本项目的文档 使用docfx.console生成其他项目的文档 直接使用docfx.exe生成项目文档 指定配置文档模板 文档地址:http://gitlab.l ...
- sphinx:python项目文档自动生成
Sphinx: 发音: DJ音标发音: [sfiŋks] KK音标发音: [sfɪŋks] 单词本身释义: an ancient imaginary creature with a lion's bo ...
- Maven生成项目文档
Maven项目可以通过maven-site-plugin插件生成项目文档,无论什么项目都可以生成. 执行命令: mvn site 生成完成的输出目录在${basedir}/target/site文件夹 ...
- maven 学习---生成基于Maven的项目文档站点
在Maven中,可以使用“mvn site”,为您的项目信息生成文档站点. mvn site 生成的网站是在项目的“target/site”文件夹中. mvn site 示例 请参见通过“mvn si ...
- 自动生成并导出word文档
今天很荣幸又破解一现实难题:自动生成并导出word文档 先看页面效果: word效果: 代码: 先搭建struts2项目 创建action,并在struts.xml完成注册 <?xml vers ...
- 使用Mkdocs构建你的项目文档
使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明. windows 10 x64 当然还有广大的windo ...
- MkDocs项目文档生成器
简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用 ...
- 基于数据库的自动化生成工具,自动生成JavaBean、数据库文档、框架代码等(v5.8.8版)
TableGo v5.8.8版震撼发布,此次版本更新如下: 1.新增两个扩展字段,用于生成自定义模板时使用. 2.自定义模板新增模板目录,可以选择不同分类目录下的模 ...
- 通过VuePress管理项目文档(一)
VuePress 相关链接 完整的Vue组件代码以及完整的文档,仅适用于个人参考学习: 文档预览地址:预览链接 使用VuePress编辑文档的代码访问:组件文档 完整代码:组件代码 Vue组件开发 这 ...
随机推荐
- C# 建立UDP服务器并接收客户端数据
C# 建立UDP服务器并接收客户端数据 2015-02-11 17:20 1218人阅读 评论(0) 收藏 举报 分类: C#开发技术(22) 版权声明:本文为博主原创文章,未经博主允许不得转载. ...
- mysql的两种常用的引擎
MyISAM引擎特点1.不支持事务(事务是指逻辑上的一组操作,组成这组操作的各个单元,要么全成功,要么全失败)2.表级锁定(数据更新时锁整个表):其锁定机制是表级锁定,这虽然可以让锁定的实现成本很小但 ...
- HDU - 6315 Naive Operations (线段树+思维) 2018 Multi-University Training Contest 2
题意:数量为N的序列a和b,a初始全为0,b为给定的1-N的排列.有两种操作:1.将a序列区间[L,R]中的数全部+1:2.查询区间[L,R]中的 ∑⌊ai/bi⌋(向下取整) 分析:对于一个位置i, ...
- HTML中表格table边框border(1px还嫌粗)的解决方案:
摘自:http://blog.sina.com.cn/s/blog_ae809a730102vrx8.html 第一种方法: 1.将table的属性设置为:BORDER=0 .cellspacing= ...
- 源码编译配置lnmp部署zabbix
环境说明: [root@wcy ~]# cat /etc/redhat-release CentOS release 6.9 (Final) [root@wcy ~]# uname -a Linux ...
- git 强制放弃本地修改(新增、删除文件)【转】
本文转载自:https://blog.csdn.net/u012672646/article/details/56676804 本地修改了一些文件,其中包含修改.新增.删除的,不需要了想要丢弃,于是做 ...
- Spring 模块
- [BZOJ2017][Usaco2009 Nov]硬币游戏
Description 农夫约翰的奶牛喜欢玩硬币游戏,因此他发明了一种称为“Xoinc”的两人硬币游戏. 初始时,一个有N(5 <= N <= 2,000)枚硬币的堆栈放在地上,从堆顶数起 ...
- C++线程池总结
本文采用pthread实现线程池,有以下几个类. CTask:任务抽象类,主要提供接口,供子类实现. CMyTask:继承CTask实现接口 CThreadPool:线程池类,用于管理线程. 信号量: ...
- git原理学习
http://git.oschina.net/progit/ 这一点值得牢记:Git 会把工作目录的内容恢复为检出某分支时它所指向的那个提交对象的快照.它会自动添加.删除和修改文件以确保目录的内容 ...