VScode中添加头部注释

VScode中添加头部注释

1.在vscode中添加扩展 koroFileHeader，安装该安装包

2.设置
在文件—首选项–设置–搜索fileheader–选择Fileheader: Cursor Mode
在光标处插入函数注释,默认配置:{‘description’:‘’,‘param’:‘’,‘return’:‘’}–点击"在setting.json中编辑"----添加下面代码

// 头部注释
"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": "xiaobai", // 写死的固定值 不从git config中获取
    "Date": "Do not edit", // 文件创建时间(不变)
    // LastEditors、LastEditTime、FilePath将会自动更新 如果觉得时间更新的太频繁可以使用throttleTime(默认为1分钟)配置更改更新时间。
    "LastEditors": "xiaobai", // 文件最后编辑者 与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 config user.name , All Rights Reserved. "
    // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
},
// 函数注释
"fileheader.cursorMode": {

    "description": "", // 函数注释生成之后，光标移动到这里
    "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
    "return": "",
}

添加以后，若是显示下面信息，则进行git用户名和邮箱设置
@Author: error: error: git config user.name & please set dead value or install git && error: git config user.email & please set dead value or install git & please set dead value or install git

解决办法：

1、全局配置
打开终端，运行以下命令，配置全局的“user.name”和“user.email”：所有的Git项目都会使用这个用户名和邮箱信息。

$ git config --global user.name "your_username"
$ git config --global user.email "your_email"

2.单个项目配置
只想配置单个项目的“user.name”和“user.email”，进入该项目目录，在终端运行以下命令

$ cd /path/to/your/project
$ git config user.name "your_username"
$ git config user.email "your_email"

完成配置后，你可以验证配置是否成功，通过以下命令查看Git中配置的用户名和邮箱：

$ git config user.name
$ git config user.email