- 浏览: 24125 次
- 性别:
- 来自: 北京
最新评论
作用
为js文件生成文档的一个自动化工具,类似于java-doc功能。通过读取javascript中一定格式的注释内容生成对应的文 档。
如何使用jsdoc
将jsdoc下载之后,在对应的目录下运行命令:
java -jar jsrun.jar app/run.js -a -t=templates/jsdoc app/test.js 就可以了。
参数说明:
-a 全部生成文档包括没有注释的方法。
-t 使用模板的地址
-d 生成文档的输出目录
具体的标签参考http://code.google.com/p/jsdoc-toolkit/。
工作原理
app : 存放的是js文件。包括一些实例文件和读取js和模板生成文档的js文件。
java : 存放的是rhino 这是一个脚本java写的javascript脚本引擎,用来提供js的运行环境。
templates : 存放生成文档的模板。 更具不同的模板可以生成html xml等各种类型文档。
conf : 提供默认的配置的文件。
jsrun.jar jsdebug.jar : 生成的入口调用了rhino框架和js文件。
工作模式 : 就是通过一段java代码调用rhino框架提供了一个运行javascript的环境,然后再运行javascript读取生成文档的javascript文件和模板文件生成文档。
发表评论
-
HTML Form中的相对路径和绝对路径
2011-08-30 23:49 3063先看一下下面的URL:http://192.168.1.1:8 ... -
CSS Sprites合并
2011-08-18 22:17 01. CSS Sprite的一个难点就是绘制大图 : ... -
Apache中 RewriteCond 规则参数介绍
2011-07-29 14:15 691Apache中 RewriteCond语句对于我来说一直是个难 ... -
Javascript中得cookie
2011-07-17 21:11 0cookie的格式: document.cookie ... -
编辑器相关
2011-07-17 14:04 0获得选中区域的内容: Ie中 : docu ... -
JavaScript 派发事件
2011-07-15 19:38 1118在传统事件模型中: 对于事件的注册 ... -
viewport
2011-05-14 00:49 0device pixels 和 css pixels 差别 ... -
定位和z-index
2011-05-10 20:54 0浮动 > z-index > 排列顺序 -
github学习介绍
2011-04-22 18:06 863git学习记录 ... -
sencha学习
2011-04-19 21:10 0在core里面主要提供了一下几个功能对象: ... -
sencha carousel和tangram carousel
2011-04-19 13:11 0sencha carousel 主要分为两部分: ... -
CSS3 media query
2011-04-14 16:44 0CSS3 media query ... -
HTML5
2011-04-12 01:35 0HTML5的设计原理 1. 平稳退化 ... -
Gradients
2011-04-01 17:24 0df -
Javascript中的setTimeOut(0)
2011-04-01 11:46 0setTimeOut 什么时候使用 ... -
open-flash-chart
2011-03-19 12:20 0生成flash图表的方法(附加源码) 各 ... -
PHP知识点总结
2011-03-17 13:39 12301. DIRECTORY_SEPARATOR ... -
Smarty模板
2011-03-13 22:25 1591一:配置 1. 创建一 ... -
pchart
2011-03-13 22:15 0中文问题 strock和render方法 ... -
vim的一些快捷键和linux的几个命令
2011-02-25 20:15 1537这几天在一直在用vim进行开发这里对一些常用的快捷键进行一个 ...
相关推荐
JSDoc 参考手册.CHM、JSDoc 中文文档.CHM、JSDoc 中文教程.CHM
swagger-jsdoc, 在JSDoc上生成 swagger doc swagger记录代码并保持实时和可以重用的OpenAPI ( Swagger ) 规范。 这里规范可以是你的api驱动项目的核心: generate,服务器,客户,测试,以及更多的基于丰富的OpenAPI...
chm api jsf myfaces jsdoc
jsdoc AMD注释生成例子,用jaguarjs模板.
使用JSDoc建立JavaScript代码的文档
Atom-atom-3en-jsdoc.zip,用于Atom的JSdoc插件,3en用于所有Suitescript项目Atom 3en JSdoc包,atom是一个用web技术构建的开源文本编辑器。
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。它是google 推荐的JsDoc生成工具。
该jaguarjs jsdoc模板已经修复版权配置和源文件行数显示或者不显示 "templates": { "cleverLinks": true, "monospaceLinks": true, "linenums":false, "default": { "outputSourceFiles": false }, ...
前端开源库-vigour-jsdoc2mdvigur-jsdoc2md,将jsdoc注释块转换为markdown
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
前端开源库-ljve-jsdoc-templateljve jsdoc模板,jsdoc 3的ljve.io模板来自jaguar.js
前端开源库-ui5-jsdoc-generatorui5 jsdoc生成器,为在ui5 edit中完成的控件库创建自动文档
前端开源库-jsdoc-xjsdoc-x,解析器,用于通过jsdoc的explain(-x)命令从文档代码中输出定制的javascript对象。
前端开源库-jsdoc-webpack-pluginjsdoc webpack插件,jsdoc webpack插件
jsdoc javascript文档生成的东东。不用勿下,免得浪费你的c币
JSDoc 模板这是一个非常接近默认模板的 jsdoc 模板。变化添加引导程序和一些样式更改。 使用下拉菜单修复了导航栏。 修复了当前页面元素的内联导航。用法 jsdoc -t /path/to/jsdoc-template如果您使用 grunt-jsdoc,...
Atom-atom-easy-jsdoc.zip,atom编辑器的jsdoc热键。Atom Easy JSdoc包,atom是一个用web技术构建的开源文本编辑器。
整洁的jsdoc 简约干净的模板。 特征 通过自定义样式 通过突出显示代码语法 预习 注意最新版本1.0被认为是重大更改,因为设计发生了重大变化。 例子 使用tidy-jsdoc? 打开一个问题以在此处添加您的文档。 基于并受...
VueJS的JSDoc 一个JSDoc插件,用于列出* .vue文件中的道具,数据,计算数据和方法。 要求 节点10+ Vue 2 安装 $ npm install --save-dev jsdoc jsdoc-vuejs 您还需要安装与您的Vue版本匹配的vue-template-...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具