一.javascript注释规范 我们在编写javascript文件的时候,一般会添加一些注释.例如一些文件.类.方法和属性都应该用合适的标记和类型进行注释.这里不但方便我们的阅读,也能养成一个好的习惯.更大的好处是,我们可以根据这些注释生成帮助文档. 二.JSDoc 3 JSDoc 3是一个生成为Javascript生成API文档的工具.下载地址为:https://github.com/jsdoc3/jsdoc .使用JSDoc 3 我们需要有Node.js环境.Node.js安装好之后,我们…

============== js 点击事件后没方法名,调用有方法名 document.getElementById('lind').onclick=abc;//传统的id选择器 中没有# 哦 function abc(){ alert(1);} 调用 :abc(); css的属性的:  在 js 中用=‘xx’ ================== 安装方法有多种.我这使用以一种, 1.安装node 2.在 dos 命令中 输入:npm install jsdoc@"<=3.3.0&qu…

有时往往我们需要建一个文档来记录js中的一些代码注释,比如一些公共的函数,又或者一些类,在团队合作中,文档接口也是必不可少的,传统的方式多少有些不便,这里介绍一个工具,它叫JSDOC,它可以用来将注释生成文档. 虽然说是说它可以把注释生成文档,但是也不是什么注释都可以的,我们需要按照它的规范来写. 首先我们通过npm来下载它. npm install jsdoc -g JSDOC的格式是这样的. /** * 两个数相加* @param {number} num1 加法* @param {numb…

官网文档:http://usejsdoc.org/index.html一个比较全的jsdoc示例 /** * @fileoverview 文件上传队列列表显示和处理 * @author 水车 **/ KISSY.add('gallery/form/1.3/uploader/queue', function (S, Node, Base) { var EMPTY = '', $ = Node.all, LOG_PREFIX = '[uploader-queue]:'; /** * @name Qu…

nodeJS使用: 直接:npm install jsdoc -g使用:jsdoc [name].js 简介 JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档.对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像,没错,JsDoc Toolkit 就是基于 JavaDoc 开发的. 下载地址 http://code.google.com/p/jsdoc-toolki…

JSDoc是一个根据javascript文件中注释的信息,生成API文档的工具.生成的文档是html文件.类似JavaDoc和PHPDoc. 用法 /** 一坨注释之类的 */JSDoc会从/**开头的注释中抽取信息.用/*,/***开头的注释会被JSDoc忽略.如 /** This is a description of the foo function. */ function foo() { } /** * Represents a book. * @constructor * @para…

几天工作上需要文档化一些Javascript东西,所以在找一些JS文档化工具,以下分析几种工具. 1.JSDoc-toolkit 一开始还想用这个工具,但后来在解析生成文档时候,出现了很严重的错误,还存在其他问题. 问题1:闭包存在时候,解析出错(很严重) ,导致几乎就不能用来做JS文档化. 问题2:在Javascript部分,注释怎么写都不对,感觉这个工具使用起来很困难 问题3:如果是静态函数或prototype设置函数,就会出问题,warning错误,然后生成的文档很怪异 之所以会出现上面种…

注释以/**  开始     */结束 JSDoc 命令属性 命令名 描述 @param @argument 指定参数名和说明来描述一个函数参数. @return @returns 描述函数的返回值. @author 指示代码的作者. @see 创建一个HTML链接指向指定类的描述. @version 指定发布版本. @requires 创建一个HTML链接,指向这个类所需的指定类. @throws @exception 描述函数可能抛出的异常的类型. {@link} 创建一个HTML链接,指向…

### 利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览 http://segmentfault.com/a/1190000002583569…

使用jsDoc可使用特定注释,将注释的内容生成文档,可用于生成脚本库的API文档 jsdoc 文档:   http://usejsdoc.org/…