前言最近在做项目代码重构，其中有一个要求是为代码添加智能提示和类型检查。更烦躁的是，智能提示就是依赖于静态类型检查的，所以在以前，指望 JavaScript 的智能提示完善度追上 Java 基本不可能。当然，时代在进步，TypeScript 已经问世许久，

ES6的包处理方式；webpack打包方式；BDD测试用例，只写了部分；使用jsdoc生成注释文档；你用eslint优化代码格式；主要在于学习相关的技术与在平时的开发中总结一些常用的技巧，当然很多的函数是借用前辈经验。项目运行下载及查看node 需要 6.

2. 哪些需要形成文档2.1 注释随着前端的发展，文档已经慢慢的变得不可或缺了，并由社区的努力而形成了 JSDoc，类似 JavaDoc 和 PHPDoc。

香港中文大学研究生,《移动Web前端高效开发实战》作者之一，《前端开发者指南2017》译者之一，在中国前端开发者大会,中生代技术大会等技术会议发表过主题演讲, 专注于新技术的调研和使用.最近在做公司内部的一个的一个SDK的重构，这里总结一些经验分享给大家。

JsDoc Toolkit 是一款辅助工具，按照它的约定在Javascipt代码中添加对于的注释，会自动生成API文档。JsDoc Toolkit是用Java编写的，所以运行的时候需要Java环境。-a 全部函数生成文档，包括没有写注释的 -d=

如今前端工程师需要维护的代码变得极为庞大和复杂，代码维护、打包、发布等流程上浪费的时间精力也越来越多。精简流程、提高效率，是每一个前端团队都会遇到的问题。大部分前端团队使用Ant脚本进行这一系列流程的自动操作。Ant主要用于代码构建、打包、部署的自动化操作

JsDoc Toolkit不久前发布了2.3.2版本，主要还是对前版本的修复。@param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值。@deprecated指示一个函数已经废弃，而且在将来的代码版本中将彻底删

为js文件生成文档的一个自动化工具，类似于java-doc功能。通过读取javascript中一定格式的注释内容生成对应的文 档。更具不同的模板可以生成html xml等各种类型文档。

1）JSDoc，是perl编写的，运行稳定，模板修改也挺方便，经过简单汉化和模板风格修改之后，是首选。3）YUIDoc，Python编写的，没有实际使用，不过相信是不错的，因为Y的工程师团队是最令我敬佩的团队之一，因为Y了解并提供了前端开发的一整套很帅的解

随着Web2.0的风靡，Javascript已经成为一门被人们重新认识的编程语言，由于大量JS开源框架的出现，利用Javascript开发的项目越来越多，越来越大。同时，也有越来越多Javascript开发问题暴露出来，如性能、网页加载速度等，其中，Jav

前言最近在做项目代码重构，其中有一个要求是为代码添加智能提示和类型检查。更烦躁的是，智能提示就是依赖于静态类型检查的，所以在以前，指望 JavaScript 的智能提示完善度追上 Java 基本不可能。当然，时代在进步，TypeScript 已经问世许久，

JsDoc Toolkit不久前发布了2.3.2版本，主要还是对前版本的修复。JSDoc通常自己就可以检测出这种信息，不过，在某些情况下则必须使用这个标记 @private 指示一个类或函数是私有的。私有类和函数不会出现在HTML文档中，除非运行JSDoc

最近在做项目代码重构，其中有一个要求是为代码添加智能提示和类型检查。更烦躁的是，智能提示就是依赖于静态类型检查的，所以在以前，指望 JavaScript 的智能提示完善度追上 Java 基本不可能。当然，时代在进步，TypeScript 已经问世许久，为

我首先创建一个示例类JokeMachine，它存储一个笑话列表，调用sayRandomJoke会随机讲一个笑话。/** * HelloWorld类存储一位客人的名字，并打招呼。首先，在全局安装jsdoc或则局部安装。npm install -g jsdoc

jsdoc是前端自动生成文档所常用的工具。我们只要按照jsdoc的语法来书写注释就能顺利的生成一片很漂亮的文档。只是jsdoc针对的是js文件，对于.vue文件似乎就有些无能为力了。不过既然vue这么人气，相信一定也会有相应的工具。在找了一圈之后，果然找到