vscode 快速生成js注释 配置和书写规范

配置

• 参考 day07-31 .prettierrc setting.json 注释模板
• 安装插件 koroFileHeader

说明

• 顺序
  @param/return { type } parameter-name describe
  顺序不能乱 否则查看时，显示为形参为any
• 可选? 或者|
  多个类型 | 比如： { string | number } val
  参数可以不存在 ? 比如：{ ?number } val
• 形参为数组对象处理
  数组对象属性的类型显示, 数组[ , ] 对象{, }
• 类型细节
  • 直接写Object为any 所以用{}或者object
  • 直接用Array[] 会出现Array[][] 这样写不美观，直接用[]
  • 统一：对象或者数组使用[]和{}，其他类型为小写，除了Date、RegExp
• 举例高亮
  @example {} ''可以让内容高亮
• 对象属性写法
  { attr: type } //属性:类型
  过多属性时，去掉@param前面星号，后边{{不换行书写，能保持高亮并语法提示

/**
* @description:
@param {{
name: string,
phone: string,
weChat: string,
客户姓名 手机号 微信号
*/

参考模板

/**
 * @description: 处理num标识+-.策略
 * @param {number} val
 * @param { [string] | string} symbol 传数组注意'-' '+'优于 '.'
 * @example '['+','.']'
 * @return {number}
 */
/**
 * @description: 限制输入最大最小值
 * @param {number} val 
 * @param {?number} min 
 * @param {number} max 
 * @return {number} val
 */
/**
 * @description: 封装上下文，只对外提供一个接口
 * @param {string} type
 * @param {[]} ...params
 * @return { undefined | Function}
 */
/**
 * @description: 解析plains为发布页面渲染的renderplains
 * @param {{}} plain 
 * @param {number} mode 某些任务选中加搜索时，弹框表单增加keyWords 
 * mode为-1 针对其他类型 mode 0 1 针对访客 1 >1 针对淘气
 * @param {[number]} twoAlgorithmNums 两种分配算法，当所选的分配方式不在里面，就删除递增量
 * @param {[number]} customArrayNums 
 * @param {{stringNumber: string}} carryOutModeLabel 用于分配方式类型转义文本
 * @param {boolean} carryOutModeNeedHour 用于控制date和time显示，只会取一个
 * @param {{stringNumber: number}} ratioObj 
  @return {{indexSymbol: Date,plainId: number | string, 
  '...typeTableTotal': {}, '...form': {} , assignsDaysObj: {}}}  {
    indexSymbol,
    plainId,
    ...typeTableTotal,
    ...form,
    assignsDaysObj
  }
 */

处理num标识+-.策略

限制输入最大最小值

封装上下文，只对外提供一个接口

解析plains为发布页面渲染的renderplains