Javascript:前端利器 之 JSDuck
2024-08-31 05:35:40
背景
文档的重要性不言而喻,对于像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,下面是使用的批处理程序:
cd /d D:\Ruby200-x64\dev
ruby dk.rb init
3、修改config.yml的内容:
# This configuration file contains the absolute path locations of all
# installed Rubies to be enhanced to work with the DevKit. This config
# file is generated by the 'ruby dk.rb init' step and may be modified
# before running the 'ruby dk.rb install' step. To include any installed
# Rubies that were not automagically discovered, simply add a line below
# the triple hyphens with the absolute path to the Ruby root directory.
#
# Example:
#
# ---
# - C:/ruby19trunk
# - C:/ruby192dev
#
---
- D:\Ruby200-x64
4、使用批处理执行安装,下面是使用的批处理程序:
cd /d D:\Ruby200-x64\dev
ruby dk.rb install
第三步:安装rdiscount
执行如下批处理程序:
gem install rdiscount
第四步:安装jsduck
执行如下批处理程序:
gem install jsduck
JSDuck教程
官方永远是最好的学习地方:https://github.com/senchalabs/jsduck/wiki。
备注
写文档是个好习惯,当然我也相信好代码是最好的文档。
最新文章
- JS特效之Tab标签切换
- java.lang.NoSuchMethodError: javax.servlet.http.HttpServletRequest.isAsyncStarted()Z 的解决
- 【leetcode】Unique Binary Search Trees (#96)
- [原创]IIS7.5下配置ASP+PHP环境及错误处理(0xc0000135)
- jquery设置下拉菜单
- 转:用WCAT进行IIS压力测试
- jQuery实现抖动效果
- 移除了css框架,世界干净了
- 【英语】Bingo口语笔记(68) - come系列
- 最简单的视音频播放示例4:Direct3D播放RGB(通过Texture)
- BZOJ2295: 【POJ Challenge】我爱你啊
- PHP环境配置综合篇
- Java面试题之数据库三范式是什么
- Razor强类型视图下的文件上传
- js中的一元运算符
- Java 数值类型以及计算
- 老李分享:Web Services 特性 1
- ubuntu下创建python的虚拟环境
- CLR查找和加载程序集的方式(一)
- Datediff的使用(统计本日,昨日,本周,本月)
热门文章
- javax.persistence.EntityNotFoundException: Unable to find报错
- OOD沉思录 --- 面向动作与面向对象 --- 避免泛滥成灾的类
- 洛谷P1486 [NOI2004]郁闷的出纳员 [STL,平衡树]
- Python模块-xml
- openstack多region配置
- React Native 系列(三)
- Scrapy实战篇(五)爬取京东商城文胸信息
- 最短路:我的理解--Dijkstra算法
- Javascript中的异步
- Educational Codeforces Round 11 A. Co-prime Array 水题