外星人源码论坛 首页 编程经验 Jsduck的使用

Jsduck的使用

2018-3-5 06:42
原作者: 外星人源码网 来自: 外星人源码网 收藏 分享 邀请

简介 jsduck是senchalabs众多开源项目中的一个,它是使用ruby编写的 javascript API文档生成器。不像JSDoc一样,不按照符合JSDoc的注释语法来进行注释的话,可能生成的文档一个字也没有,学习曲线较陡。jsduck适合以 ...

简介

jsduck是senchalabs众多开源项目中的一个,它是使用ruby编写的 javascript API文档生成器。不像JSDoc一样,不按照符合JSDoc的注释语法来进行注释的话,可能生成的文档一个字也没有,学习曲线较陡。jsduck适合以OOP方式构造代码(如Ext JS是结构化的)的js文件,不适合以功能性风格构建代码(如jQuery)的js文件。

安装

下载安装包

项目地址:https://github.com/senchalabs...
windows下安装的话,可在这个地址下载.exe可执行文件,将下载后的文件更名为jsduck.exe,放到一个目录下面。

配置环境变量

windows下需要配置环境变量。环境变量分为系统环境变量和用户环境变量两种。系统环境变量,对所有用户起作用。而用户环境变量只对当前用户起作用。 我们可配置在用户环境变量的path中,也可配置在系统环境变量的path中。
点击计算机,右键选择属性——》高级-》环境变量,在Path中进行设置。

配置完成,进入dos命令,运行jsduck --help,能出来信息,则表示配置成功。

使用

可通过配置jsduck.json,也可通过直接在命令行写参数来使用。

配置jsduck.json

进入项目目录,配置jsduck.json文件,类似以下的写法

运行jsduck命令,即可在dist文件夹下找到自动生成的api文档。


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

粉丝 阅读74 回复0
上一篇:
【整理】前端国际化小结发布时间:2018-03-05
下一篇:
EventBus原理发布时间:2018-03-05
推荐资讯
阅读排行
国内最专业的源码技术交流社区
全国免费热线电话

0373-5171417

周一至周日9:00-23:00

反馈建议

admin@eenot.com 在线QQ咨询

扫描二维码关注我们