js-doc 常用书写格式

接上篇 js-doc集成vuecli 传送门

已经在vue项目中安装了 js-doc 接下来就是按照规范书写注释代码来生成文档

先来个图吧

首先组件说明

/**
 * 自定义下拉选择区间组件
 * @module 组件名
 * @author ***
 * @description 组件描述
 *  */

props 说名

  /**
   * Props 说明
   * @prop {type} 参数名称 注释内容
   */

类似的 计算属性 组件引用等一致的

方法说明

/**
 * 解释
 * @function 方法名称
 * @param {type} 参数1- 参数注释
 * @return 
 */

其他详细说明 传送门