JSDoc的使用

2019独角兽企业重金招聘Python工程师标准>>>

1、简单介绍

        JSDoc是一个根据javascript文件中注释信息，生成JavaScript应用程序或库、模块的API文档 的工具。你可以使用他记录如：命名空间，类，方法，方法参数等。类似JavaDoc和PHPDoc。现在很多编辑器或IDE中还可以通过JSDoc直接或使用插件生成智能提示。从而使开发者很容易了解整个类和其中的属性和方法，并且快速知道如何使用，从而提高开发效率，降低维护成本。

2、作用

（1）、生成api文档

（2）、生成智能提示

3、官方文档

gitbook文档：http://www.css88.com/doc/jsdoc/index.html

html5+联盟：http://www.html5plus.org/doc/jsdocp.html#type_syntax

4、生成文档

https://github.com/jsdoc3/jsdoc

npm install jsdoc -g

jsdoc yourJavaScriptFile.js

 

 

 

 

 

 

 

转载于:https://my.oschina.net/u/1416844/blog/849986