VSCode 注释插件


简介

文件头部添加注释:
* 在文件开头添加注释,记录文件信息/文件的传参/出参等
* 支持用户高度自定义注释选项, 适配各种需求和注释。
* 保存文件的时候,自动更新最后的编辑时间和编辑人
* 快捷键:window:ctrl+alt+i,mac:ctrl+cmd+i, linux: ctrl+meta+i

在光标处添加函数注释:
* 在光标处自动生成一个注释模板
* 支持用户高度自定义注释选项
* 快捷键:window:ctrl+alt+t,mac:ctrl+cmd+t,linux: ctrl+meta+t

快捷键不可用很可能是被占用了,参考这里

安装

搜索KoroFileHeader,并安装。

设置

打开此扩展插件设置,默认在setting.json中编辑

 "fileheader.customMade": {} // 头部注释
 "fileheader.cursorMode": {} // 函数注释 

示例

"fileheader.customMade": {
        "Author": "JunQiLiu",
        "Date": "Do not edit", 
        "LastEditTime": "Do not edit", 
        "Description": "",
        "FilePath": "Do not edit", 
        "custom_string_obkoro1": " "
    },
    "fileheader.cursorMode": {
        "description":"",
        "param":"",
        "return":"",
        "note":"",
        "Author": "JunQiLiu",
    }

效果

头部注释:

/*
 * @Author: JunQiLiu
 * @Date: 2020-10-12 02:56:10
 * @LastEditTime: 2020-10-12 21:02:29
 * @Description: 
 * @FilePath: \ModbusHUB\applications\main.c
 * @ 
 */

函数注释:

/**
 * @description: 
 * @param {type} 
 * @return {type} 
 * @note: 
 * @Author: JunQiLiu
 */
  • 分享:
评论
还没有评论
    发表评论 说点什么