- 浏览: 119501 次
- 性别:
- 来自: 成都
文章分类
最新评论
-
煎蛋就是幸福:
...
试读《跨终端Web》 -
xiaoshitoushifa:
最好把demo贴上啊!发一份到435065893@qq.com ...
漂亮的系统后台UI 欣赏 -
xiaoshitoushifa:
只有图片 没有demo 啊
漂亮的系统后台UI 欣赏
JsDoc Toolkit不久前发布了2.3.2版本,主要还是对前版本的修复。
如果你需要使用Ant,JsDoc还有一个Ant插件:JsDoc Toolkit Ant Task
下载JsDoc Toolkit2.3.2:http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip
命令名描述
@param @argument 指定参数名和说明来描述一个函数参数
@returns 描述函数的返回值
@author 指示代码的作者
@deprecated 指示一个函数已经废弃,而且在将来的代码版本中将彻底删除。要避免使用这段代码
@see 创建一个HTML链接,指向指定类的描述
@version 指定发布版本
@requires 创建一个HTML链接,指向这个类所需的指定类
@throws @exception 描述函数可能抛出的异常的类型
{@link} 创建一个HTML链接,指向指定的类。这与@see很类似,但{@link}能嵌在注释文本中
@fileoverview 这是一个特殊的标记。如果在文件的第一个文档块中使用这个标记,则指定该文档块的余下部分将用来提供这个文件的概述
@class 提供类的有关信息,用在构造函数的文档中
@constructor 明确一个函数是某个类的构造函数
@type 指定函数的返回类型
@extends 指示一个类派生了另一个类。JSDoc通常自己就可以检测出这种信息,不过,在某些情况下则必须使用这个标记
@private 指示一个类或函数是私有的。私有类和函数不会出现在HTML文档中,除非运行JSDoc时提供了--private命令行选项
@final 指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量
@ignore JSDoc忽略有这个标记的函数
JsDoc:是js文档生成工具,它从javascript程序源代码中抽取类、方法、成员等注释信息形成一个和源代码配套的API帮助文档。
Java开源项目http://www.jsdoctoolkit.org/,它是一个功能强大的javascript文档生成工具。
下面我们来结束一下如何使用。
我们通过下载工具类库。
这里我们使用的是jsdoc_toolkit-2.1.0.zip也是当前的最高版本。
我们将这个文件解压。可以看到里面README.txt文件。
这里有详细的使用说明。【好像介绍到这里就可以了。当然你也可以继续读下】
这里我们需要通过命令行进行创建javascript文档。
java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
当然如果感觉通过命令行的方式比较麻烦,我们可以自行创建一个.bat文件
将上面的内容复制到该文件中,执行即可。
下面我来简单解释一下这其中的参数
-a 表示全部的方法
-e 表示对应的文件的编码根式 这里对应的是GB18030 默认的是utf-8
-t 表示生产doc的文档样式模板
这里的test/*.js表示在test目录下的全部javascript文件
执行完毕后将文档结果默认输出到/out/jsdoc目录下。当然这个目录也是可以定义的
具体参数可以使用
java -jar jsrun.jar app/run.js --help
进行查看。
结果如下:
复制代码 代码如下:
OPTIONS:
-a or --allfunctions
Include all functions, even undocumented ones.
-c or --conf
Load a configuration file.
-d=<PATH> or --directory=<PATH>
Output to this directory (defaults to "out").
-D="myVar:My value" or --define="myVar:My value"
Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.
-e=<ENCODING> or --encoding=<ENCODING>
Use this encoding to read and write files.
-E="REGEX" or --exclude="REGEX"
Multiple. Exclude files based on the supplied regex.
-h or --help
Show this message and exit.
-n or --nocode
Ignore all code, only document comments with @name tags.
-o=<PATH> or --out=<PATH>
Print log messages to a file (defaults to stdout).
-p or --private
Include symbols tagged as private, underscored and inner symbols.
-q or --quiet
Do not output any messages, not even warnings.
下面我们来创建test下的js文件
简单的方法标注
myjs.js
复制代码 代码如下:
/**
* @fileOverview 简单的方法标注示例
* @author <a href="llying.iteye.com">llying</a>
* @version 0.1
*/
/**
* @description 加法运算
* @param {Num} num1 加数
* @param {Num} num2 被加数
* @return {Num} result 结果
*/
function add(num1,num2){
return num1 + num2;
}
/**
* @description 减法运算
* @param {Num} num1 减数
* @param {Num} num2 被减数
* @return {Num} result 结果
*/
function minus(num1,num2){
return num1 - num2;
}
类的方法标注
myjs2.js
复制代码 代码如下:
/**
* @fileOverview 简单的类对象标注示例
* @author <a href="llying.iteye.com">llying</a>
* @version 0.1
*/
/**
* @author llying
* @constructor Person
* @description 一个Person类
* @see The <a href="#">llying</a >.
* @example new Parent(“张三”,15);
* @since version 0.1
* @param {String} username 姓名
* @param {Num} age 年龄
*/
function Person(username,age)
{
/**
* @description {Sting} 姓名
* @field
*/
this.username = username;
/**
* @description {Num} 年龄
* @field
*/
this.age = age
/**
* @description 弹出say内容
* @param {String} content 内容
*/
this.say = function(content)
{
alert(this.username+" say :"+content);
}
/**
* @description 返回json格式的对象
* @return {String} json格式
* @see Person#say
*/
this.getJson = function(){
return "{name:"+this.username+",age"+this.age+"}";
}
}
现在我们可以运行java -jar jsrun.jar app/run.js -a -e=GB18030 -t=templates/jsdoc test/*.js
详细出处参考:http://www.jb51.net/article/26249.htm
发表评论
-
javascript 数据类型判断
2014-10-13 14:44 726javascript 中判断数据类型有两种情况:1.基本数据 ... -
阻止事件追加
2014-10-11 12:04 862有些时候可以使用 e.stopPropagation(); ... -
试读《ECMAScript6入门》
2014-09-20 00:01 1291ECMA 对于前端开发工作的我并不陌生,《Ja ... -
javascript 宽度获取
2014-09-11 11:27 583网页可见区域宽:document.body.clientWi ... -
用jquery开发幻灯片播放功能(完整版)
2014-04-10 12:08 924很久没有写了,今天写一个简单的效果,幻灯片无限滚动和大家一起 ... -
看了一篇 “javascript 绝句欣赏”
2013-07-24 16:37 0看了一篇 “javascript 绝句欣赏”这里面的代码写 ... -
javascript 闭包的理解
2013-05-17 16:06 1151javascript中的作用域、 ... -
javascript forEach的实现
2013-04-10 11:43 609function forEach(ary,fn){ ... -
call理解
2013-04-09 16:40 853call使用情况 1.class.call(obj) ... -
富文本框参考
2013-01-31 17:56 0http://www.cnblogs.com/bluedrea ... -
JavaScript中prototype、__proto__、Function、Object等
2012-11-07 15:46 865javascript 灵活度太大了,比如定义一个类,就可以使用 ... -
javascript call的使用
2012-11-06 01:18 659Javascript中call的使用自己感觉蛮纠结的,根 ... -
javascript 继承的实现
2012-11-06 00:55 8111.类抄写 function parent(){ ... -
利用正则表达式实现去除所有HTML标签代码
2012-09-22 10:00 2595"<[^>]*>"; / ... -
javascript判断页面加载(页面下载)是否完毕
2012-09-11 16:03 1583首先要明确两个概念 1.window.onload:页面加载 ... -
如何发送简单请求
2012-08-30 15:08 808使用XMLHttpRequest 对象发送请求的基本步骤: ... -
javascript 正则 捕获组与非捕获组
2012-08-30 11:26 2617捕获组 语法: ... -
dom
2012-08-23 11:08 759继承在dom中的重要性,以下为a标记继承关系图 ... -
查看浏览器dom支持情况
2012-08-23 10:15 734查看浏览器dom支持情况 http://www.w3. ... -
浏览器之间的差别是处理dom对象的不同
2012-08-22 17:24 731dom是一组用来描述脚本怎样与结构化文档进行交互和访问的 ...
相关推荐
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。它是google 推荐的JsDoc生成工具。
swagger-jsdoc, 在JSDoc上生成 swagger doc swagger记录代码并保持实时和可以重用的OpenAPI ( Swagger ) 规范。 这里规范可以是你的api驱动项目的核心: generate,服务器,客户,测试,以及更多的基于丰富的OpenAPI...
入门swagger-jsdoc将经过验证的OpenAPI规范返回为JSON或YAML。 const swaggerJsdoc = require ( 'swagger-jsdoc' ) ;const options = { swaggerDefinition : { openapi : '3.0.0' , info : { title : 'Hello World' ...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
Java JsDoc Toolkit v2.0文档工具下载,可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,这款工具也是google 极力推荐的JsDoc输出工具。
openapi-jsdoc以json格式返回OpenAPI规范。 const openapiJSDoc = require ( 'openapi-jsdoc' ) const api = openapiJSDoc ( { definition : { // info object, see ...
JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。这个JsDoc是Java版本的,用起来方便一些。这也是 google 推荐的 JsDoc 输出工具
swagger-jsdoc将经过验证的swagger规范返回为JSON。 在提供程序json中使用以下代码在应用程序根目录中的bootstrap文件夹内的app.js文件中注册adonis-swagger-jsdoc 'adonis-swagger-jsdoc/providers/...
基于Unist规范的语法树JSDoc 安装 $ npm install @geut/jsdast 用法 const unified = require ( 'unified' ) const { parser } = require ( '@geut/jsdast' ) const tree = unified ( ) . use ( parser ) . parse ...
内容索引:JAVA源码,综合应用,JsDoc,文档生成工具 JsDoc Toolkit 是一个文档导出工具,它可以把javaScript描述信息格式化,开发者只要按JsDoc规范写好注释就可以很方便的导出文档。这是Java版本的,附有JAVA源文件,...
end-utils使用工具函数:import 具体的工具方法 from front-end-utils/+文件夹名称(在api里找,你想用啥,文件夹名称就是啥)注意事项每个工具方法都是独立存在的每个工具方法都不依赖框架文件命名请按照命名规范包...
生成OpenAPI规范和客户端的示例项目 您将在此处找到后端和前端实施。 :warning: 首先启动后端,以便能够构建前端! 该项目简单演示了如何设置Node.js + Express + TypeScript,并添加了一个特殊端点,该端点生成...
可以从以下位置获取文档文档,包括JSDoc生成的API参考:JSONAPI-Vuex文档内容重组数据入门使用功能操作吸气剂突变帮助程序功能实用程序功能配置端点开发重组数据属性JSONAPI是一种非常有用的格式,用于与
typera-openapi是一种工具,该工具自动为使用进行路由的项目创建定义。 目录 入门 安装typera-openapi: npm install typera-openapi 您的路由文件必须具有一个默认导出,用于导出Typera路由器。 JSDoc注释用作...
Kitjs,(http://xueduany.github.com/KitJs),是我2011年底,离开淘宝UED之后,自己搞起的...所以近期也对原来的所有模块按照jsdoc规范更新了一遍API文档,逐步开源给大家使用。 先放个Kitjs族谱,让大家对于kit有个
Moye 是 ECOM UI 1.1 规范的一个轻量级实现。 如何使用 前期准备: git、nodejs、grunt-cli 与 edp 获取源码: $ git clone git://github.com/ecomfe/moye.git $ cd moye 安装依赖: $ npm install 生成 API ...