jsdoc写作规范

1，注释规范：

    使用/** 开头注释

---

2，几个重点标签：

    @author  作者，方便定位

    @class @constructor  标记类和构造函数

    @constant @const常量标记

    @description @desc 对内容进行描述

    @module 模块名称

    @enum 枚举类型标记

    @global 全局对象标记

    @param 函数参数标记

    @returns @return 函数返回标记

    @this this指向标记

    @see 参考链接

    @memberof 标记模块间的从属关系

    @event 在模板中标记可以被触发的事件，与@fire配合使用

3，如何注释代码

    以.vue组件为例：

    1，模块注释：

        @module 注明模块名

    上面一行默认是描述信息

模块注释

    2， 方法注释

        使用@method注释方法，后面跟方法名，使用@param注释方法的参数，@param {} xxx格式，{}中填写参数类型（如有则填写），xxx为方法值和描述信息，格式为方法名  方法描述（中间以空格隔开）

方法注释

    3，props属性注释

        使用@props属性注释，注释格式如下

    

4，docs生成命令

npm run docs

5,配置详解：

在jsdoc-vue目录下的jsdoc-vue.conf.js里面配置需要处理的文档路径

jsdoc配置文件

include表示需要处理的目录，

exclude代表排除目录，

includePattern使用正则表达式匹配，只处理匹配到的文件类型

附jsdoc参考链接：

jsdoc中文APi