• 我转过几个弯 绕过那个小雨楼
  • 拿着蒲扇摆着衣衫渡着紧箍咒
  • 不问天涯不停留 喝过几壶酒
  • 不过年少白头道义放胸口
  • 倘若明天之后 遥看前尘剑封侯
  • 似那天上神仙无所求
  • 朝朝暮暮君如梦醒十分不为何理由
  • 是真是假是惶恐是无休
  • 路过这风雨花满楼 片刻都不停留
  • 我本这书生进京赶考留下许多愁
  • 你问有没有时候 我叹这天道默悠悠
  • 能否与我一醉方休
  • 又过了几个弯 算尽天量道莫慌
  • 踏这田园闻这芳草香
  • 跌跌撞撞仗剑天涯折煞不枉无笔良
  • 是梦是幻是温柔是家乡
  • 路过这风雨花满楼 片刻都不停留
  • 我本这书生进京赶考留下许多愁
  • 你问有没有时候 我叹这天道默悠悠
  • 能否与我一醉方休
  • 路过这风雨花满楼 片刻都不停留
  • 我本这书生进京赶考留下许多愁
  • 你问有没有时候 我叹这天道默悠悠
  • 能否与我一醉方休
  • 谁能与我一醉方休

js 函数注释

函数注释的一个常用的格式:

/**
 * @description: 函数描述
 * @param {类型} 参数 描述
 * @return {类型} 描述
 */
  1. description 就是函数的说明,干什么用的
  2. param 是函数的参数; {}里面表示这个参数是什么类型,后面接参数名称,描述,参数有多少个,@param就有多少个
  3. return 表示要输出的内容,一般可以省略不写,也可以写,和param 差不多

示例

/**
 * @description: 测试函数
 * @param {*} a 任何类型参数
 * @param {*} b 用来xxx
 * @return {*} 返回空
 */
function test(a,b){}

快速注释插件

注释写这么多很烦人的,而且格式在有规律的情况下,自然是有插件用最好了。

vscode安装插件:KoroFileHeader

安装完毕,在需要注释的函数的上一行按下快捷键:ctrl+alt+t即可自动生成注释模板,然后自己改一改就行了。

使用这个插件,他会在你保存文件的时候在文件的头部加上一个头部注释,这个一般来说不怎么需要,所以我们需要关闭它。

文件 --- 首选项 --- 设置 --- 在右上角有一个打开json --- 打开后再里面的那个{}对象里面添加以下:

// 头部注释
    "fileheader.customMade": {
        "autoAdd": false,  //关闭自动生成头部注释
    },

保存即可。

这里放一下我的配置

// 头部注释
  "fileheader.customMade": {
    "autoAdd": false, //关闭自动生成头部注释
  },
  //函数注释
  "fileheader.cursorMode": {
    "description": "",
    "param": "",
    "return": "",
    "Date Changed": ""
  },
0
  • 本文分类:JavaScript
  • 本文标签:javascript注释
  • 流行热度:已超过 61 人围观了本文
  • 最后更新:2020年10月28日 - 23时13分06秒
  • 发布日期:2020年10月28日 - 10时07分00秒
  • 版权申明:本文系作者@木灵鱼儿原创发布在木灵鱼儿 - 有梦就能远航站点。未经许可,禁止转载。

相关文章

微信收款码
微信收款码