vscode自动添加python文件的头部注释

最新推荐文章于 2025-03-08 17:18:17 发布

旺仔的算法coding笔记

最新推荐文章于 2025-03-08 17:18:17 发布

阅读量1k

点赞数 2

CC 4.0 BY-SA版权

文章标签： vscode ide 编辑器

本文链接：https://blog.youkuaiyun.com/wangwangstone/article/details/141827467

背景: 利用vscode 进行相关配置后可以自动添加头部注释，比如作者信息，文件创建时间、最后修改时间等。

实现：

vscode的插件扩展中：安装 koro1FileHeader 插件。自动添加头部注释和更新时间。先配置settings.json (ctrl+shift+p 输入settings.json 打开），参考： https://github.com/OBKoro1/koro1FileHeader/wiki/%E5%AE%89%E8%A3%85%E5%92%8C%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B

配置模板：

"fileheader.customMade": {
    // Author字段是文件的创建者 可以在specialOptions中更改特殊属性
    // 公司项目和个人项目可以配置不同的用户名与邮箱 搜索: gitconfig includeIf  比如: https://ayase.moe/2021/03/09/customized-git-config/
    // 自动提取当前git config中的: 用户名、邮箱
    "Author": "YunTian", // 同时获取用户名与邮箱
    // "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", // 文件最后编辑时间
}

保存文件的时候，自动更新最后的编辑时间和编辑人。使用的快捷键 window：ctrl+win+i,mac：ctrl+cmd+i