vscode快速生成代码注释的两种方式

一、结合插件koroFileHeader

  1. 安装koroFileHeader插件到vscode。
  2. FIle(文件)=>Preferences(首选项)=>settings(设置),在workspace下查到File header Config,打开其中一个进行编辑(也可以ctrl + shift + p,搜索preferences :open settings)
    image.png

    添加代码块,快捷键:window:ctrl+win+i mac:ctrl+cmd+i linux: ctrl+meta+i Ubuntu: ctrl+super+i
"fileheader.customMade": {
      // 头部注释默认字段
        "Author": "***",
        "Date": "", // 设置后默认设置文件生成时间
        "LastEditTime": "", // 设置后,保存文件更改默认更新最后编辑时间
        "LastEditors": "***", // 设置后,保存文件更改默认更新最后编辑人
        "Description": "",
        "FilePath": "", // 设置后,默认生成文件相对于项目的路径
        "custom_string_obkoro1": "加油搞起来"
    },

键入快捷键,稍等一下(根据网络快慢)


image.png

添加代码块,快捷键:window:ctrl+win+t mac:ctrl+cmd+t linux: ctrl+meta+t Ubuntu: ctrl+super+t

"fileheader.cursorMode": {
        // 默认字段
        "description":"",
        "param":"",
        "return":""
    }

二、添加代码块,FIle(文件)=>Preferences(首选项)=>configure user snippets(用户代码块),选择javascript.json,修改添加

{
    "Print to zhushi": {
        "prefix": "zhushi",
        "body": [
            "<!--",
            "* @Description: $0",
            "* @Author: your name",
            "* @Date: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "* @LastEditTime: $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
            "* @LastEditors: Please set LastEditors",
            "-->"
        ],
        "description": "a zhushi mode"
    },
    "Print to func": {
        "prefix": "func",
        "body": [
            "/**",
            " * @func $1",
            " * @Description $2",
            " * @Author: your name",
            " * @param {$3} $4 $5",
            " * @return {$6} $7",
            " */"
        ],
        "description": "a func mode" 
    },
    "Print explain": {
        "prefix": "explain",
        "body": [
            "/**",
            " * @description",
            " * @param {*}",
            " * @public",
            " */  ",
        ],
        "description": "Log output to console"
    }   
}

此时在相应位置键入zhushi 、func、explain就能得到相应提示,追加注释代码


image.png

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

推荐阅读更多精彩内容