Javascript：前端利器之 JSDuck

背景

文档的重要性不言而喻，对于像Javascript这种的动态语言来说就更重要了，目前流行的JDoc工具挺多的，最好的当属JSDuck，可是JSDuck在Windows下的安装非常麻烦，这里就写下来做个备忘。

JSDuck生成的文档效果

JSDuck安装步骤

第一步：安装Ruby

Ruby下载地址：http://rubyinstaller.org/downloads/。

我是64位操作系统，下载的文件如下：

第二步：安装Development Kit

1、将DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe解压到指定目录，下图是我解压后的位置：

2、使用批处理程序生成config.yml，下面是使用的批处理程序：

1 cd /d D:\Ruby200-x64\dev
2 ruby dk.rb init

3、修改config.yml的内容：

 1 # This configuration file contains the absolute path locations of all
 2 # installed Rubies to be enhanced to work with the DevKit. This config
 3 # file is generated by the 'ruby dk.rb init' step and may be modified
 4 # before running the 'ruby dk.rb install' step. To include any installed
 5 # Rubies that were not automagically discovered, simply add a line below
 6 # the triple hyphens with the absolute path to the Ruby root directory.
 7 #
 8 # Example:
 9 #
10 # ---
11 # - C:/ruby19trunk
12 # - C:/ruby192dev
13 #
14 ---
15 - D:\Ruby200-x64

4、使用批处理执行安装，下面是使用的批处理程序：

1 cd /d D:\Ruby200-x64\dev
2 ruby dk.rb install

第三步：安装rdiscount

执行如下批处理程序：

1 gem install rdiscount

第四步：安装jsduck

执行如下批处理程序：

1 gem install jsduck

JSDuck教程

官方永远是最好的学习地方：https://github.com/senchalabs/jsduck/wiki。

备注

写文档是个好习惯，当然我也相信好代码是最好的文档。

转载于:https://www.cnblogs.com/happyframework/p/3226667.html

Javascript：前端利器之 JSDuck相关推荐

前端利器—1—转型JS编程
JS作为前端开发的必备语言工具,虽然JS对非编程人员来说比较容易上手,但是,要真正的精通JS开发,尚且假设学习过c++.java等面向对象语言的一种.因为对oo开发人员,迅速掌握JS的开发要点,是顺利 ...
JavaScript—— 前端编程语言
JavaScript 前端编程语言 http://caibaojian.com/javascript/ 转载于:https://www.cnblogs.com/highpointengineer/ ...
JavaScript前端框架的思考
(此文章同时发表在本人微信公众号"dotNET每日精华文章",欢迎右边二维码来关注.) 题记:现在JavaScript前端框架层出不穷,尤其Angular进入到2.x时候之后,我们 ...
Javascript前端加载等待圆型圈提示实现效果
Javascript前端加载等待圆型圈提示实现效果 CSS内容 #loading {background-color: #9f9f9f;opacity: 0.15;height: 100%;width ...
JavaScript前端判断文件是否存在（案例详解）
[辰兮要努力]:hello你好我是辰兮,很高兴你能来阅读,昵称是希望自己能不断精进,向着优秀程序员前行! 博客来源于项目以及编程中遇到的问题总结,偶尔会有读书分享,我会陆续更新Java前端.后台.数据 ...
前端利器CodePen和JSRUN了解一下
https://www.jianshu.com/p/a0aa7443ce77 https://www.v2ex.com/t/659859 前端利器CodePen和JSRUN了解一下 JSRUN 是一个 ...
前端加密php后端解密,使用RSA怎么实现JavaScript前端加密与PHP后端解密功能
使用RSA怎么实现JavaScript前端加密与PHP后端解密功能发布时间:2021-02-08 15:19:14 来源:亿速云阅读:97 作者:Leah 这期内容当中小编将会给大家带来有关使用R ...
《JavaScript前端开发与实例教程（微课视频版）》
#好书推荐##好书奇遇季#<JavaScript前端开发与实例教程(微课视频版)>,京东当当天猫都有发售.定价59元,网店打折销售更便宜.适合JavaScript初学者,可作为高校相关课程 ...
JavaScript前端：与PDF.js结合，实现网页PDF内容批量下载
提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 JavaScript前端:与PDF.js结合,实现网页PDF内容批量下载前言一.PDF.js是什么? 二.PDF.js单个PDF文 ...

Javascript：前端利器之 JSDuck

背景

JSDuck生成的文档效果

JSDuck安装步骤

第一步：安装Ruby

第二步：安装Development Kit

第三步：安装rdiscount

第四步：安装jsduck

JSDuck教程

备注

Javascript：前端利器之 JSDuck相关推荐

最新文章

热门文章

Javascript：前端利器 之 JSDuck

背景

JSDuck生成的文档效果

JSDuck安装步骤

第一步：安装Ruby

第二步：安装Development Kit

第三步：安装rdiscount

第四步：安装jsduck

JSDuck教程

备注

Javascript：前端利器 之 JSDuck相关推荐

最新文章

热门文章

Javascript：前端利器之 JSDuck

Javascript：前端利器之 JSDuck相关推荐