好用的VSCode头部注释插件Fileheader Pro

好用的VSCode头部注释插件Fileheader Pro是一个便捷的工具，可以自动为代码文件添加头部注释，提高代码可读性，下面将详细讲解如何使用。

安装

在VSCode插件市场搜索“Fileheader Pro”，点击安装即可。

或者通过以下命令行安装：

code --install-extension chenxsan.vscode-fileheader-pro

配置

在VSCode的Setting面板中搜索“Fileheader”，会出现File Header Pro的配置项，可以根据自己的需求设置生成头部注释的格式、作者信息、文件创建时间等内容。

其中，部分常用设置如下：

配置项	说明
fileheader.Author	作者信息
fileheader.License	版权信息
fileheader.formatOnSave	是否在保存文件时自动添加头部注释

示例

以下是两个添加头部注释的示例：

示例一

在JavaScript文件中，输入以下命令，会自动添加头部注释：

> fhp

或者使用快捷键：ctrl+alt+i

在注释中自动生成了如下信息：

/*
 * @Author: your name
 * @Date: 2021-07-26 17:37:24
 * @LastEditTime: 2021-07-26 17:37:24
 * @LastEditors: your name
 * @Description: In User Settings Edit
 * @FilePath: /test.js
 */

其中， Author为上文配置中设定的作者信息， Date为当前时间， LastEditTime和 LastEditors表示文件最后修改时间和修改者， Description可以自由设置， FilePath为文件路径。

示例二

在Python文件中，也可以使用类似的命令添加头部注释：

"fileheader": {
    "templates": {
      "python": {
        "prefix": "fhp",
        "body": [
            "# -*- coding: utf-8 -*-",
            "# @Author: your name",
            "# @Date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
            "# @LastEditTime: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
            "# @LastEditors: your name",
            "# @Description: In User Settings Edit",
            "# @FilePath: ${TM_FILEPATH}"
        ],
        "description": "Python File Header"
      }
    }
  }

对于Python文件，添加 "python" 模板，然后使用 fhp 快捷键即可自动生成头部注释，注释中包含当前文件的编码方式、作者信息、文件创建和修改时间等信息。