VSCode自动添加注释

VSCode 自动添加注释

  上班摸鱼，从注释做起(bushi)
  高效码农，从注释做起，为了让代码具备更高的可读性，清晰明朗的注释是非常有必要的。因此，我在网上搜索，找到了一个好用的VSCode插件(因为经常使用VSCode编程)。好了，坐好，现在发车！

---

1. 打开VSCode插件商店，搜索koroFileHeader，安装成功后重启客户端生效

2. 更改setting.json配置文件，设置头部注释模板与函数注释模板
配置文件设置有三种方法：

• 命令设置

打开VSCode命令面板:
 mac: command + p 
 window: ctrl + p 
 输入“> Open Settings”(注意>后面有一个空格)

• 搜索设置

设置中打开首选项 > 设置 > 搜索fileheader > 在右侧中贴上配置 > 做简单的更改

• 简单设置

已安装插件中找到koroFIleHeader > 点击小齿轮 > 打开 setting.json 文件即可

3. 将配置代码添加到配置文件中，保存完即可使用快捷键快速创建优美注释
  这部分代码可按照自己的需求更改，甚至可以用字符画出图像，详细请参考koroFileHeader官方文档。

// 头部注释
"fileheader.customMade": {
    // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
    // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
    // 自动提取当前git config中的: 用户名、邮箱
    "Author": "git config user.name && git config user.email", // 同时获取用户名与邮箱
    // "Author": "git config user.name", // 仅获取用户名
    // "Author": "git config user.email", // 仅获取邮箱
    // "Author": "OBKoro1", // 写死的固定值 不从git config中获取
    "Date": "Do not edit", // 文件创建时间(不变)
    // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
    "LastEditors": "git config user.name && git config user.email", // 文件最后编辑者 与Author字段一致
    // 由于编辑文件就会变更最后编辑时间，多人协作中合并的时候会导致merge
    // 可以将时间颗粒度改为周、或者月，这样冲突就减少很多。搜索变更时间格式: dateFormat
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    // 输出相对路径，类似: /文件夹名称/src/index.js
    "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
    // 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
    "Description": "", // 介绍文件的作用、文件的入参、出参。
    // custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
    // 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
    "custom_string_obkoro1": "", 
    // 版权声明 保留文件所有权利 自动替换年份 获取git配置的用户名和邮箱
    // 版权声明获取git配置, 与Author字段一致: ${git_name} ${git_email} ${git_name_email}
    "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by ${git_name_email}, All Rights Reserved. "
    // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
},
// 函数注释
"fileheader.cursorMode": {
    "description": "", // 函数注释生成之后，光标移动到这里
    "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
    "return": "",
}

4. 常用快捷键插入注释

• 文件头部注释快捷键

记录文件信息/文件的传参/出参，设置个性签名、留下QQ、微信联系方式、输入空行等等
支持用户高度自定义注释选项, 适配各种需求的注释形式。
保存文件的时候，自动更新最后的编辑时间和编辑人
window：ctrl+win+i,
mac：ctrl+cmd+i, 
linux: ctrl+meta+i,
Ubuntu: ctrl+super+i

• 函数注释注释快捷键

将光标放在函数行或者将光标放在函数上方的空白行。
自动解析函数参数，生成函数参数注释。
快捷键：
window：ctrl+win+t,
mac：ctrl+cmd+t,
linux: ctrl+meta+t, 
Ubuntu: ctrl+super+t

• 按函数注释快捷键

函数注释光标移动到下一行，快速添加函数参数描述
window: win+y, 
mac: cmd+y, 
linux: meta+y
生成函数注释之后，使用快捷键移动鼠标到下一行，快速为函数参数添加描述。

5. 效果展示