koroFileHeader

In vscode used to generate file header annotations and function annotations plug-in, after multiple iterations, plug-in: support all mainstream languages, flexible and convenient, complete documentation, simple to eat! If you like the plugin, give it to Star⭐️

Effect:

Introduction to the

  1. Add a comment to the file header:

    • Add comments at the beginning of the file to record file information/file input/output parameters, etc
    • Supports highly customized annotation options for various requirements and annotations.
    • When saving a file, the last edit time and editor are automatically updated
    • Shortcut:window:ctrl+alt+i.mac:ctrl+cmd+i

  2. Add a function comment at the cursor:

    • Automatically generates a comment template at the cursor
    • Support for highly customized annotation options
    • Shortcut:window:ctrl+alt+t.mac:ctrl+cmd+t
    • The shortcut keys are not available and are most likely occupied. See here

  3. Support one key to add Buddha bless never BUG, god animal protection and other notes pattern

  4. See more functions, and if you have more needs, you can send me an issue.

The installation

Search for koroFileHeader in the Vscode extension store and click install.

use

  1. File header comments:

    In the current editing file, press the shortcut keys: Window: CTRL + Alt + I/MAC: CTRL + CMD + I to generate a header comment.

  2. Function comments:

    • Place the cursor on the function line or on the blank line above the function
    • Use shortcut keyswindow:ctrl+alt+t.mac:ctrl+cmd+tTo generate function comments.
    • In fact, function comments can be generated anywhere in the file, so you need to control them yourself.

Comment the template Settings

Wiki documentation

Update log

Support language

Plug-in setup/configuration

Configuration fields

Q&A

Supported functions:

  • Support one click to add Buddha bless never BUG, god animal protection body, etc. Note patterns: write code is not coq ^_^

  • Custom annotation template information, automatically update the last edit time, the last editor.

  • Supports the form of comments in almost any language

  • Custom comment symbols: You can customize them even if the plug-in does not support a language.

  • Detect the file head without notes, automatically add head notes function, with automatic add head notes blacklist, ma ma no longer need to worry about me forget to add notes.

  • When a header comment is generated, the file path relative to the current project is automatically added

  • Header comments equal width function, improve the appearance level of the file header comments.

  • Insert the header comment into the second line, similar to the first line in PHP.

  • Insert a python-like environment declaration before and after the header comment: #! /usr/bin/env python

  • Special fields user-defined, such as the blog time field has special requirements.

  • Print a custom piece of information in a header comment/function comment. It can be a copyright notice, a signature, a blank line, etc.

  • Comment time formatting

  • Matches to a newline automatically add a comment symbol

  • Automatically moves the cursor to the Description line when generating header/function comments.

  • File diff check: Detect only changes to LastEditors and LastEditTime, will roll back the file and reduce meaningless submissions.

  • New files automatically add header comments

  • Automatically add header comments – item blacklist

Auto Commit

A new open source plug-in is recommended: Auto Commit

Git commit – this is a VSCode plugin for Git automatic commit. It can be used to supplement the previous forget to commit, and help you to fill the green box on your home page.

It’s also super easy to set up. The portal

The last

If you feel good, give me a Star ⭐️ to encourage me ~

Front-end advanced accumulation, public number, GitHub