VsCode generates comment plugin koroFileHeader

A very useful VsCode annotation plugin koroFileHeader is strongly recommended

introduce

VsCodeA plug- in that reads user-defined templates, adds file header comments through shortcut keys, and adds function comments at the cursor

Install

Open vscode, select Extensions to search for koroFileheader to install

configuration

Modify the default settings as needed

1. Select File -> Preferences -> Settings -> Search for fileheader (you can also command + ,enter )

2. Select Header Comments, Default Settings -> Click: Edit in settings.json

Here are only some simple configurations that can satisfy daily development. Students who like to toss and study can click to go to koroFileHeader github to check it out. I won’t go into details here.

//此为头部注释配置  快捷键ctrl + Command + i (mac); ctrl + Alt + i (window)
"fileheader.customMade": {
    
    
       "Description": "",
       "Autor": "you.mu",
       "Date": "Do not edit",
       "LastEditors": "you.mu",
       "LastEditTime": "Do not edit"
   },
//此为函数注释配置 快捷键ctrl + Command + t (mac); ctrl + Alt + t (window)
   "fileheader.cursorMode": {
    
    
       "description":"",
       "param": "",
       "return": "",
       "author":"you.mu"
   }

common problem

If you encounter problems such as shortcut key failure during the configuration process, it may be caused by a conflict with other plug-in commands, you can enter the vscode keyboard shortcut to make changes;

Path selection: Select File -> Preferences -> Keyboard Shortcuts, please asynchronously go to koroFileHeader FAQ for details

at last

If this article is helpful to you, please like, follow and bookmark;