深入掌握FileHeader

一、FileHeader是什么

FileHeader是一种代码注释工具，用于自动添加文件头信息，包括文件名、作者、创建时间、修改时间等等。

在我们编写代码的时候，经常需要手动添加文件头信息，这既费时又容易出错。FileHeader的出现就是为了解决这个问题，它可以通过设置默认参数，在我们添加文件时自动添加文件头信息，提高我们的开发效率，降低出错率。

二、FileHeader.customer有哪些

FileHeader.customer是自定义参数，在FileHeader设置中通过“Defalut”、“Custom1”、“Custom2”等命名的参数。

我们可以通过设置好这些参数，在我们新建文件时即可自动添加对应的文件头信息。

三、FileHeader参数

使用FileHeader的时候，我们需要了解一些参数的含义，以下是常用的参数及其含义：

/*  
 * @Author: What's your name 
 * @Date: When did you finish it 
 * @LastEditTime: When did you last edit it 
 * @LastEditors: Who changed it last time 
 * @Description: What does your code do 
 * @FilePath: Where is your code saved 
 * @version: What version is it now 
 */

其中，@Author表示作者，@Date表示创建日期，@LastEditTime表示上一次编辑时间，@LastEditors表示最后一位修改的人员，@Description表示代码描述，@FilePath表示文件的路径，@version表示版本号。

四、FileHeader怎么用

我们可以通过以下步骤来使用FileHeader：

1、打开VSCode插件管理器，并搜索文件头FileHeader插件。

2、安装FileHeader插件后，我们需要在VSCode的设置中配置代码片段的生成规则。

"fileheader.customMade": {
    "author": "What's your name",
    "date": "When did you finish it",
    "lastAuthor": "Who changed it last time",
    "lastDate": "When did you last edit it",
    "fileName": "${TM_FILENAME_BASE}",
    "description": "What does your code do",
    "filePath": "${TM_FILEPATH}",
    "version": "What version is it now"
}

3、在新建文件时，我们可以使用命令Ctrl+Shift+P，在弹出的命令列表中选择“Add File Header”命令，在文件头中自动生成代码

五、FileHeader xosc

我们还可以通过配置VSCode的用户设置来禁用或启用FileHeader插件。

1、禁用FileHeader插件

我们可以在VSCode的设置中搜索FileHeader，找到插件的设置选项，在其中添加“fileheader.enable: false”代码段即可禁用插件。

"fileheader.enable": false

2、启用FileHeader插件

同样，在VSCode的设置中搜索FileHeader，在其中添加“fileheader.enable: true”代码段即可启用插件。

"fileheader.enable": true

六、FileHeader插件禁用

在某些特殊情况下，我们可能需要禁用FileHeader插件。

我们可以通过在VSCode的用户设置中添加以下代码块来禁用FileHeader插件：

"[javascript]": {
    "editor.quickSuggestions": {
        "strings": false
    },
    "editor.suggestOnTriggerCharacters": false,
    "editor.suggest.enabled": false
}

七、FileHeader是什么意思

FileHeader翻译过来就是文件头信息，是指在程序代码头部添加的作者、时间、文件名等附加信息。

FileHeader插件可以帮助我们自动添加这些附加信息，提高生产效率。

八、FileHeader.customMade

除了默认的参数外，我们还可以使用FileHeader.customMade自定义我们需要添加的内容。在FileHeader中进行设置后，自己可以选择一些列参数添加到代码头部中。

  "fileheader.customMade": {
    "test1" : "test1-value",
    "test2" : "test2-value",
    "test3" : "test3-value"
  }

九、FileHeader dismatch the type

当我们使用FileHeader插件时，如果设置的参数类型与实际类型不同，将会导致插件失效。

比如，在实际代码中有一个参数类型为“String”，但是在插件中设置了参数类型为“array”时，插件将无法自动添加文件头信息。

因此，我们在使用FileHeader插件时，一定要注意将参数设置正确。

十、总结

FileHeader插件的出现，解决了我们在编码时手动添加文件头信息的问题。它可以自动添加文件头信息，提高我们的工作效率，降低出错率。我们需要学会使用FileHeader插件，并且设置好对应的自定义参数，以便更好的适应我们的需求。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/240697.html