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

配置

说明

  • 顺序
    @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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341