VSCodeFileHeader

VSCode FileHeader

vscode文件頭部註釋插件，支持多語言，歡迎大家嘗試，以及問題的提出，覺得不錯的小夥伴們，給個Star，謝謝～

github: https://github.com/caizhengxin/vscodefileheader

Install

ext install jankincai.vscodefileheader

Features

• 支持自動更新最後修改人和時間
• 支持自定義模板(header/body)
• 支持多語言
• 支持後綴名映射模板
• 支持過濾，不添加頭部註釋
• 支持手動和自動插入頭部註釋

Usage

# Settings
{
    "fileheader.author": "JanKinCai",
}

# Set save file or ``ctrl + alt + i`` insert comment

Demo

Python:

Vue:

XML:

Language

• ActionScript
• AppleScript
• ASP
• Batch
• C
• C#
• C++
• Clojire
• CSS
• D
• Diff
• Erlang
• Go
• Haskell
• HTML
• Java
• JavaScript
• LaTeX
• Lisp
• Lua
• Matlab
• Objective-C
• OCaml
• Pascal
• Perl
• PHP
• Python
• R
• Ruby
• Scala
• SCSS
• ShellScript
• SQL
• TypeScript
• Vue
• XML
• YAML

配置

• 設置作者

{
    "fileheader.author": "Your name"
}

• 自定義後綴名映射

{
    "fileheader.file_suffix_mapping": {
        ".pyx": "Python"
    }
}

• 設置開啓插入body

{
    "fileheader.body": true
}

• 設置打開文件，自動插入頭部註釋

{
    "fileheader.open": true,
}

• 設置保存文件, 自動插入頭部註釋, 默認 true

{
    "fileheader.save": true,
}

如果設置爲false, 存在頭部會自動更新最後修改人和時間，不存在頭部需要按ctrl + alt + i

• 設置時間格式，參考moment.js

{
    "fileheader.dateformat": "YYYY-MM-DD HH:mm:ss"  # moment.js
}

• 過濾不需要頭部註釋的文件

{
    "fileheader.ignore": [
        "*.txt",
        "test.py",
        "test"
    ]
}

• 自定義模板，例子

# 自定義Header模板
header模板路徑：template/header/Python.tmpl，把下面的內容寫入文件：

# -*- coding: utf-8 -*-
# @Author: {{author}}
# @Date:   {{create_time}}
# @Last Modified by:   {{last_modified_by}}
# @Last Modified time: {{last_modified_time}}

# 自定義Body模板
body模板路徑：template/body/Python.tmpl，把下面的內容寫入文件：

print("Hello, World!")

設置上面的template路徑

{
    "fileheader.custom_template_path": "xxx/template/"
}