/simple-comment-header

VSCode extension that writes a simple comment header to the current file with some useful information.

Primary LanguageJavaScriptMIT LicenseMIT

Simple Comment Header

Simple Comment Header writes a simple comment header to the current window with some useful information.

> Insert Comment Header

Insert Comment Header

Features

Writes a comment header containing the user name, the current date and the file name.

Options to show or hide file name and creation date.

It should not insert headers on files starting with comments.

It DOES NOT update headers based on the settings, you must delete the header and run the command again.

Notifications: Notifications

Supports:

  • C
  • C++
  • CSS
  • Javascript
  • Java (untested)
  • PHP (untested)
  • Swift (untested)
  • Any language that uses /* */ for comments

Will not function correctly with other programming language, work in progress

Usage

Command Palette

Command Effect
Insert Comment Header Insert Comment Header
comhead Insert Comment Header

Example:

Commands

Insert Comment Header and comhead are equivalent.

Configuration

  • myheader.userName: Username displayed in the header comment. Default: User name
  • myheader.showDate: If enabled, adds creation date. Default: true
  • myheader.showFileName: If enabled, add current file name. Default: true
  • myheader.showNotifs: If enabled, displays a Notification when creating a header and a Warning if the header has already been created. Default: true

License

MIT

Release Notes

ChangeLog