当前位置: 首页 > article >正文

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

背景: 利用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

http://www.kler.cn/a/288022.html

相关文章:

  • 使用 Web Search 插件扩展 GitHub Copilot 问答
  • w~视觉~合集23
  • MongoDB分布式集群搭建----副本集----PSS/PSA
  • Vue监视属性变化watch
  • Win11 终端执行 python xxx.py 没反应
  • 65 mysql 的 表元数据锁
  • Jenkins+docker+springboot 一键自动部署项目步骤
  • 代码随想录刷题记录(七)——二叉树(2)
  • WordShield 一款轻量级且灵活的敏感词过滤库
  • 【论文阅读】语义通信安全研究综述(2024)
  • Xinstall赋能,H5与App完美融合,打造极致用户体验
  • 关于武汉芯景科技有限公司的多协议收发芯片XJ3160开发指南(兼容MAX3160)
  • react 样式和vue样式的区别
  • Fabric.js TextBox揭秘:splitByGrapheme属性实现文本自然换行
  • Android使用IntentService
  • JavaScript初级——Navigatior
  • 《从C/C++到Java入门指南》- 25.final 关键字
  • 跨地域工作利器:深度解析2024年远程控制软件的新特性
  • 力扣SQL仅数据库(1068~1084)
  • 做数据爬虫工作:是否需要准备单独的IP库和爬虫库?
  • ADAS---基于检测框的单目测距方法
  • 微服务--认识微服务
  • 在线压缩pdf,无需安装就可轻易压缩pdf文件
  • 双线服务器与BGP服务器的区别?
  • 文件上传的学习
  • node版本切换