文档章节

五分钟玩转文档化工具JSDuck

老司机带你撸代码
 老司机带你撸代码
发布于 2017/11/30 22:30
字数 905
阅读 592
收藏 10

字数:981

阅读时间:5分钟

选型依据


​ 在经历了数个上线的项目之后,笔者所在的团队已经沉淀了一个相对稳定版本的前端框架。因此,我们需要出具一套框架API文档,以便公司其他成员的使用和框架的后期维护。我们在对现在较主流的五个文档工具:JSDoc 3、YUIDoc、Dox、Docco、JSDuck分别作了调研和尝试,得到结论如下:

工具优点缺点
JSDoc3提供了完整的模板开发、事件触发等接口,使用非常灵活。对代码要求比较严格,学习曲线较高。
YUIDoc不止支持JS语言,更加抽象,如果同时使用了 Ruby/PHP/Python等语言YUI都可以使用。功能更加抽象,具体实现方面考虑不全。
Dox轻量级、高度可定制化,兼容JSDoc3语法。后期会有较多问题需要自己解决。
Docco行间注释方式,更注重实现过程的文档不太适合API注释
JSDuck代码实时修改、语法灵活、支持MarkDown语法,支持查看源码并且文档可读性较高,最主要的是上手非常快。可定制化支持不足,略显臃肿。

​ 我们选型的条件权重由高到低依次是:

​ 1.较强的可读性。

​ 2.较低的学习成本。

​ 3.注释语义的丰富程度,是否满足我们的需求。

​ 4.是否足够灵活。

​ JSDuck可读性较高,上手较快,并且使用JSDuck工具生成的extJS文档的成功有目共睹,综合考量,我们最终选择了JSDuck工具。

环境部署


​ 由于JSDuck需要依赖ruby环境,所以环境部署分为以下三步:

​ 1.安装ruby

​ 2.安装devkit

​ 3.安装JSDuck

第一步,安装ruby :

​ 下载地址:https://rubyinstaller.org/downloads/

图1

​ 选择符合本机电脑的安装包下载即可。

第二步,安装devkit:

​ 下载地址:https://rubyinstaller.org/downloads/

图2

​ 选择符合本机电脑的安装包下载即可。注意devkit安装目录不要有中文或者特殊字符,然后在安装根目录下执行cmd命令 ruby dk.rb init。这时,我们会在当前目录下看到一个config.yml文件,编辑该文件,添加ruby目录配置。例如,笔者的ruby是安装在 F:/Ruby22-x64 目录下,就做如下图修改即可:

图3

​ 安装成功后,执行命令 ruby dk.rb install 命令。

第三步:安装JSDuck

​ 执行命令 gem install jsduck 命令安装jsduck。

​ 至此,JSDuck的环境部署已经全部完成了。

第一个文档


​ 准备工作终于做完了,那还等什么,当然是马上开始看看我们成果如何啦!

​ 在 G:\test-jsduck目录下,创建一个test.js文件,编写如下代码:

/**
 * @class 人类
 * @author lsjcoder
 * @docauthor lsjcoder
 */
function People(){
	/**
	 * 
	 * @property {String} 姓名
	 */
	this.name = "lsjcoder";

	/**
	 * 吃饭
	 * @method
	 * @param food {String} 食物名称
	 * @return {Boolean}  是否吃过
	 */
	this.eat = function(food){
		if(food != null){
			return true;
		}else{
			return false;
		}
	}
}

​ 然后在cmd中运行命令 jsduck "G:\test-jsduck\test.js" --output=G:\test-jsduck\doc ,工具就自动将文档生成到目录 G:\test-jsduck\doc 下,直接运行里面的 index.html 文件就可以看到如下成果图:

图4

​ 是不是非常简单粗暴且可读性爆表呀!笔者会在接下来的系列文章中详细介绍JSDuck的所有技术,并且最后会将笔者公司在JSDuck中前端框架的实践以案例的形式分享给大家,敬请期待哦!

欢迎关注我的微信公众号:

© 著作权归作者所有

共有 人打赏支持
老司机带你撸代码
粉丝 52
博文 22
码字总数 36413
作品 0
武汉
高级程序员
私信 提问
【CF 应用开发大赛】WeBot - 微信公众平台消息接口类库(nodejs)

应用名称:WeBot - 微信公众平台提供的开放信息接口的自动回复系统,基于node.js 实现。 创新点(亮点): 1. 开源类库,基于node.js,支持快速开发微信公众平台的消息处理后台系统。https:/...

天猪
2013/01/25
0
17
Hadoop 的数据处理解决方案--Cascalog

Cascalog 是 Hadoop 上的数据处理解决方案,无需 hassle。 Cascalog 是 Clojure 或者 Java 的全功能数据处理和查询库。Cascalog 主要的作用是处理 Hadoop 上的“大数据”或者分析你的本地电脑...

叶秀兰
2014/10/28
625
0
Helm 架构 - 每天5分钟玩转 Docker 容器技术(161)

在实践之前,我们先来看看 Helm 的架构。 Helm 有两个重要的概念:chart 和 release。 chart 是创建一个应用的信息集合,包括各种 Kubernetes 对象的配置模板、参数定义、依赖关系、文档说明...

cloudman6
04/29
0
0
用 Weave Scope 监控集群 - 每天5分钟玩转 Docker 容器技术(175)

创建 Kubernetes 集群并部署容器化应用只是第一步。一旦集群运行起来,我们需要确保一起正常,所有必要组件就位并各司其职,有足够的资源满足应用的需求。Kubernetes 是一个复杂系统,运维团...

cloudman6
05/31
0
0
Kubernetes Dashboard - 每天5分钟玩转 Docker 容器技术(173)

前面章节 Kubernetes 所有的操作我们都是通过命令行工具 完成的。为了提供更丰富的用户体验,Kubernetes 还开发了一个基于 Web 的 Dashboard,用户可以用 Kubernetes Dashboard 部署容器化的...

cloudman6
05/27
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Spring应用学习——AOP

1. AOP 1. AOP:即面向切面编程,采用横向抽取机制,取代了传统的继承体系的重复代码问题,如下图所示,性能监控、日志记录等代码围绕业务逻辑代码,而这部分代码是一个高度重复的代码,也就...

江左煤郎
今天
3
0
eclipse的版本

Eclipse各版本代号一览表 Eclipse的设计思想是:一切皆插件。Eclipse核心很小,其它所有功能都以插件的形式附加于Eclipse核心之上。 Eclipse基本内核包括:图形API(SWT/Jface),Java开发环...

mdoo
今天
1
0
SpringBoot源码:启动过程分析(一)

本文主要分析 SpringBoot 的启动过程。 SpringBoot的版本为:2.1.0 release,最新版本。 一.时序图 还是老套路,先把分析过程的时序图摆出来:时序图-SpringBoot2.10启动分析 二.源码分析 首...

Jacktanger
今天
3
0
小白带你认识netty(二)之netty服务端启动(上)

上一章 中的标准netty启动代码中,ServerBootstrap到底是如何启动的呢?这一章我们来瞅下。 server.group(bossGroup, workGroup);server.channel(NioServerSocketChannel.class).optio...

天空小小
今天
3
0
聊聊storm trident batch的分流与聚合

序 本文主要研究一下storm trident batch的分流与聚合 实例 TridentTopology topology = new TridentTopology(); topology.newStream("spout1", spout) .p......

go4it
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部