VS Code 插件推荐： psioniq File Header 自动添加文件头，可标注作者，时间等信息

碎碎念

在文件同步的时候，经常会遇到出现冲突文件，有时候分不清哪个版本才是自己最后保存的版本。因此想到了用文件头来标识来帮助解决同步冲突的问题。当然也可以借此标注license，个人联系方式等信息

安装

插件页面直接搜 psioniq File Header就可以找到

配置

拓展详情页点击齿轮按钮 ⚙-Extension Settings

或者CTRL+P 输入settings打开VS Code设置，然后输入@ext:psioniq.psi-header, 找到Config，点击Edit in settings.json

示例配置文件

可以根据参考自行定义参数： https://github.com/davidquinn/psi-header
作为一名懒人，我喜欢在保存文件的时候就自动添加文件头, 以下是个人的配置示例

Python默认的文件头注释格式可能会导致运行的时候报错，因此单独做了处理

  "psi-header.config": {
    "forceToTop": true,
    "blankLinesAfter": 1,
    "author": "Leon",
    "authorEmail": "-"
  },
  "psi-header.templates": [
    {
      "language": "*",
      "template": [
        "File Created: <<filecreated('dddd, Do MMMM YYYY h:mm:ss a')>>",
        "Author: <<author>> (<<authoremail>>)",
        "Last Modified: <<dateformat('dddd, Do MMMM YYYY h:mm:ss a')>>"
      ]
    }
  ],
  "psi-header.changes-tracking": {
    "isActive": true,
    "modAuthor": "Modified By:",
    "modDate": "Last Modified:",
    "modDateFormat": "dd/MM/yyyy hh:nn:ss",
    "include": [],
    "includeGlob": [],
    "exclude": ["markdown", "json", "jsonc", "shellscript"],
    "excludeGlob": ["./**/*/ignoreme.*", "**/settings.json"],
    "autoHeader": "autoSave",
    "enforceHeader": true
  },
  "psi-header.lang-config": [
    {
      "language": "python3",
      "begin": "################################################################################",
      "prefix": "# ",
      "suffix": "#",
      "lineLength": 80,
      "end": "################################################################################",
      "forceToTop": true,
      "blankLinesAfter": 3,
      "beforeHeader": [],
      "afterHeader": [],
      "rootDirFileName": "package.json",
      "modAuthor": "Modified By:",
      "modDate": "Last Modified:",
      "modDateFormat": "dd/MM/yyyy hh:nn:ss",
      "replace": ["Filename:", "Project"],
      "ignoreLines": []
    },
    {
      "language": "python",
      "mapTo": "python3"
    }
  ]

效果

FAQ

Q: 修改设置后未生效/文件头不会自动生成
A: 重启VS Code