原文地址:http://www.cnblogs.com/hxling/archive/2012/11/27/2791067.html jsDoc 说白了就是帮助你生成JS的文档,但有个前提,就是你编写的JS代码中,需要按一定的格式写注释后,这个工具软件才能帮你正确的生成文档! 一.配置使用环境.此软件是 JAVA写的,所以我们要在windows 系统中配置java的环境变量 1.下载jdk(http://java.sun.com/javase/downloads/index.jsp),我下载的版…

一.javascript注释规范 我们在编写javascript文件的时候,一般会添加一些注释.例如一些文件.类.方法和属性都应该用合适的标记和类型进行注释.这里不但方便我们的阅读,也能养成一个好的习惯.更大的好处是,我们可以根据这些注释生成帮助文档.如下就是一个比较规范的javascript注释例子. /** * MyClass类 * @class MyClass * @constructor */ function MyClass() { /** * a属性 * @property a *…

所有插件查找地址(https://marketplace.visualstudio.com/) 编码快捷方式(http://docs.emmet.io/cheat-sheet/) 安装插件出现  错误unable to verify the first certificate (无法确认第一证书) 解决方法如下: 在vscode 下 进入 文件->首选项-->设置 在上面的搜索框输入 proxy,会出现 有3个相关设置项,设置如下的选项  // 是否应根据提供的 CA 列表验证代理服务器证书.…

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

官网文档: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…

官网:http://www.jetbrains.com/webstorm/ webStorm,File=>setting=>JavaScript-Libraries How WebStorm Works: Completion for JavaScript Libraries One of the essential features of WebStorm’s editor is code completion. The way it is implemented in WebStorm i…

1.eslint需要依赖node.js环境,在配置之前需要安装好node.js; 2.npm install eslint --save-dev 或 npm install eslint --save -g 进行全局安装 3.配置到自己的编辑器里面,这里已webstorm为例,ctrl+alt+s调出settings面板,依次配置即可 4.在项目根目录下新建文件.eslintrc并配置如下内容即可: ps:了解更多配置,请查阅https://github.com/yangsendyx/ESLin…

//ESLint 4.5.0,参考了eslint官方以及alloyteam团队配置 module.exports = { parser: 'babel-eslint', parserOptions: { ecmaVersion: 2017, sourceType: 'module', ecmaFeatures: { experimentalObjectRestSpread: true, jsx: true } }, env: { browser: true, node: true, common…