OBKoro1 / koro1FileHeader

VSCode插件:自动生成,自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数,支持所有主流语言,文档齐全,使用简单,配置灵活方便,持续维护多年。
MIT License
5.65k stars 274 forks source link

Copyright 用户名显示 ${git_name} #591

Open tisfeng opened 1 year ago

tisfeng commented 1 year ago

注意!很多问题都可以在配置字段查看所有配置中和issue里得到解决!

注意!很多问题都可以在配置字段查看所有配置中和issue里得到解决!

注意!很多问题都可以在配置字段查看所有配置中和issue里得到解决!

注意:

  1. 可以先试一下常见问题中的方法.
  2. 然后搜一搜以前关闭的issue看有没有相似的问题可以帮助解决问题。
  3. 打开fileheader.configObj.showErrorMessage看看没有没有报错信息
  4. issue提的越清晰,越容易定位问题/找到bug,越快速的解决问题。

注意!请一定要按照规范来提Issue,这样问题能更快的得到解决!

注意!请一定要按照规范来提Issue,这样问题能更快的得到解决!

注意!请一定要按照规范来提Issue,这样问题能更快的得到解决!

描述bug(必填)

用户名显示 ${git_name}

注释设置(必填):

// 头部注释
  "fileheader.customMade": {
    // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
    // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
    // 自动提取当前git config中的: 用户名、邮箱
    "Author": "git config user.name", // 获取用户名
    // "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", // 文件最后编辑者 与Author字段一致
    // 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
    // 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    "FilePath": "only file name", // 文件在项目中的相对路径 自动更新
    // 插件会自动将光标移动到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}, All Rights Reserved. "
    // "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 写死的公司名/用户名, All Rights Reserved. "
  },

VsCode设置:

// 配置填在这里面

文件后缀(必填):

ts

你得到的注释(必填):

你生成的注释为:

/*
 * @author: tisfeng
 * @createTime: 2023-09-14 21:21
 * @lastEditor: tisfeng
 * @lastEditTime: 2023-09-15 10:36
 * @fileName: index.ts
 *
 * Copyright (c) 2023 by ${git_name}, All Rights Reserved.
 */

预期的行为(必填):

/*
 * @author: tisfeng
 * @createTime: 2023-09-14 21:21
 * @lastEditor: tisfeng
 * @lastEditTime: 2023-09-15 10:36
 * @fileName: index.ts
 *
 * Copyright (c) 2023 by tisfeng, All Rights Reserved.
 */

屏幕截图(选填)

image

问题相关(选填)

在这里添加关于这个问题的任何其他上下文。

错误日志(选填):

怎么生成错误日志?

tisfeng commented 1 year ago

之前是正常的,我有几个月没有 VSCode 写代码了,所以不确定具体什么时候出现了这个问题

image

我的 git 配置最近也没有修改, git config user.name 值没有问题

image
juinshell commented 1 year ago

我也遇到同样的问题。copyright用${git_name} ${git_email} ${git_name_email}都无效

Lslightly commented 11 months ago
Copyright (c) ${now_year} by git config user.name, All Rights Reserved. 

直接输命令似乎可行,虽然不知道原理是什么