jsdoc的使用

JSDoc使用指南

1.JSDoc安装和配置：

JSDoc安装：使用npm安装npm install jsdoc –g

JSDoc配置：进入JSDoc的安装目录找到并修改 conf.json.EXAMPLE``进行自定义配置，也可以不做修改使用默认配置

2.JSDoc注释文档编辑：

格式： /**

               * @标签 文档内容

               */

常用功能标签：

       desc/description 描述方法、变量，放在第一排可省略

       method/function   方法名

       param    参数，可定义类型

       property    属性，可定义类型

       return  方法返回值，可定义类型

       todo 描述函数的功能

       global   表示变量是否是全局

       constructs 表明是构造函数

       default  默认值

       alias  别名

       event  事件

       example  示例

       type   变量类型

       module   标明当前文档模块

文档信息标签

       version   版本信息

       author   作者

       license   开源协议

       link   链接

3.生成文档文件

使用cmd进入当前项目文件，输入命令：jsdoc 文件相对路径.js

（注意，默认配置下，输入文档必须是js类型不能是html类型）

回车后，在当前项目文件根目录下会生成一个out文件夹，里面有3个文件夹fonts、scripts、styles分别是生成文档的字体、脚本和css样式,根目录下的html文档文件就是JSDoc文档。