使用 DocFX 生成 .Net/Unity项目文档

时间:2021-11-23 03:03:36

孙广东  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/

使用 DocFX 生成 .Net/Unity项目文档

我好奇的是如何生成  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 命令

  1. 下载

https://github.com/dotnet/docfx/releases

  1. 使用

创建初始项目

docfx init -q

此命令生成一个名为docfx_project的默认项目。

  1. 生成网站   (每次需要跟新API或者 修改了配置 都要在执行这个命令重新生成)

docfxdocfx_project\docfx.json --serve

现在你可以访问http://localhost:8080查看生成的网站。使用 -p 端口 可以指定端口。

注意:  不要有中文路径, 特别是在docfx.json  配置中!

使用 DocFX 生成 .Net/Unity项目文档

我只是 修改了docfx.json 中的:

"metadata": [

{

"src": [

{

"src": "src/Unity-Technologies-ui-0155c39e05ca",

"files":["**/**.cs"]

}

],

"dest": "api"

}

],

"build": {

……………………………………..

然后执行生成网站的命令。

配置的路径要和  程序的执行路径要注意啊!

使用 DocFX 生成 .Net/Unity项目文档

工具的功能肯定不仅如此, 更多配置就自己看吧!

设置Unity项目 也是一样可以正常生成的:

使用 DocFX 生成 .Net/Unity项目文档

{

"metadata": [

{

"src": [

{

"src": "src/NiuGames",

"files":["**/**.cs"]

}

],

"dest": "api"

}

],

"build": {

因为Unity项目中什么都有, 第三方插件等等!

使用 DocFX 生成 .Net/Unity项目文档

你可以细化具体包含的路径 和 排除的路径!

完!

使用 DocFX 生成 .Net/Unity项目文档的更多相关文章

  1. 使用Docfx生成项目文档

    使用docfx.console生成本项目的文档 使用docfx.console生成其他项目的文档 直接使用docfx.exe生成项目文档 指定配置文档模板   文档地址:http://gitlab.l ...

  2. sphinx:python项目文档自动生成

    Sphinx: 发音: DJ音标发音: [sfiŋks] KK音标发音: [sfɪŋks] 单词本身释义: an ancient imaginary creature with a lion's bo ...

  3. Maven生成项目文档

    Maven项目可以通过maven-site-plugin插件生成项目文档,无论什么项目都可以生成. 执行命令: mvn site 生成完成的输出目录在${basedir}/target/site文件夹 ...

  4. maven 学习---生成基于Maven的项目文档站点

    在Maven中,可以使用“mvn site”,为您的项目信息生成文档站点. mvn site 生成的网站是在项目的“target/site”文件夹中. mvn site 示例 请参见通过“mvn si ...

  5. 自动生成并导出word文档

    今天很荣幸又破解一现实难题:自动生成并导出word文档 先看页面效果: word效果: 代码: 先搭建struts2项目 创建action,并在struts.xml完成注册 <?xml vers ...

  6. 使用Mkdocs构建你的项目文档

    使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明. windows 10 x64 当然还有广大的windo ...

  7. MkDocs项目文档生成器

    简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用 ...

  8. 基于数据库的自动化生成工具,自动生成JavaBean、数据库文档、框架代码等&lpar;v5&period;8&period;8版&rpar;

    TableGo v5.8.8版震撼发布,此次版本更新如下:          1.新增两个扩展字段,用于生成自定义模板时使用.          2.自定义模板新增模板目录,可以选择不同分类目录下的模 ...

  9. 通过VuePress管理项目文档&lpar;一&rpar;

    VuePress 相关链接 完整的Vue组件代码以及完整的文档,仅适用于个人参考学习: 文档预览地址:预览链接 使用VuePress编辑文档的代码访问:组件文档 完整代码:组件代码 Vue组件开发 这 ...

随机推荐

  1. &lbrack;Spark内核&rsqb; 第33课:Spark Executor内幕彻底解密:Executor工作原理图、ExecutorBackend注册源码解密、Executor实例化内幕、Executor具体工作内幕

    本課主題 Spark Executor 工作原理图 ExecutorBackend 注册源码鉴赏和 Executor 实例化内幕 Executor 具体是如何工作的 [引言部份:你希望读者看完这篇博客 ...

  2. python中的None

    python中的None python中的None就相较于Java中的Null.python中就没有所谓的NULL.网络上很多的时候说的"python的Null"这个说法本身就是不 ...

  3. nginx反向代理中proxy&lowbar;set&lowbar;header 运维笔记

    Nginx proxy_set_header:即允许重新定义或添加字段传递给代理服务器的请求头.该值可以包含文本.变量和它们的组合.在没有定义proxy_set_header时会继承之前定义的值.默认 ...

  4. Shell的for和select

    环境准备: [root@nodchen-db01-test day07]# mkdir -p /server/scripts/day07/test/{test.txt,oldboy.txt,oldgi ...

  5. http 的request和response 在servlet的应用文件下载

    一)response 我们通过浏览器访问网站的时候,处理响应的是response. 它由三部门组成:响应行.响应头.响应体 作用:往浏览器写东西. 1)响应行 格式:协议/版本  状态码 状态码说明. ...

  6. Docs命令大全 备用

    #1 一: net use \\ip\ipc$ " " /user:" " 建立IPC空链接 net use \\ip\ipc$ "密码" ...

  7. 03-JVM内存模型:堆与方法区

    一.堆(Heap) 1.1.什么是堆 堆是用于存放对象的内存区域.因此,它是垃圾收集器(GC)管理的主要目标.其具有以下特点: 堆在逻辑上划分为“新生代”和“老年代”.由于JAVA中的对象大部分是朝生 ...

  8. Spring Security静态资源访问

    在使用Spring Security时要求所有请求都需要授权访问,此时会定义过滤规则如下 protected void configure(HttpSecurity http) throws Exce ...

  9. Markdown 语法快速入门手册

    Markdown 是一种轻量级标记语言,能将文本换成有效的XHTML(或者HTML)文档,它的目标是实现易读易写,成为一种适用于网络的书写语言. Markdown 语法简洁明了,易于掌握,所以用它来写 ...

  10. Vue 组件 非父子组件通信

    有时候两个组件也需要通信(非父子关系),在简单的场景下,可以使用一个空的vue实例作为*事件总线: var bus = new Vue(); //触发组件a中的事件 bus.$emit('id-se ...