木灵鱼儿

木灵鱼儿

阅读:547

最后更新:2020/10/28/ 23:13:06

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
文章被阅读 547

相关文章

目录树