Skip to content

Add boilerplate code to display information and structure your code through comments! Chose between defferent templates for the headers! Commenting your code has never been easier.

License

Notifications You must be signed in to change notification settings

Ttiki/ultra-comment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Latest version Downloads Open Issue Open PR Sponsor

Header comments

Note: This README is also available in:

Add boilerplate code when you start a new file to store informations (such as the name of the file/class, author's name, date of creation, etc.) PLUS, a bonus snippet to structure your code by adding some additional information!

This extension is available for the following text editor / IDE :

  • Visual Studio Code
  • [] Atom (Newer versions aren't supported for the moment.)

Studio Code

Features

Here is a list of features from the Vistual Studio Code Header comment extension:

  • Snippets automaticaly adapts to the language you're using
  • Dates automaticaly updates
  • Multiple templates you can use (depending on your need and styles)
  • Multi-languages (english, french, etc.)
  • An handy snippet to structure your code (complementary-information, see gif below for a demonstration)

Header comments Header comments features in Visual Studio Code

Complementray information Complementary information to structure your code

Installation

  1. To install this extension download the latest release for your text editor/IDE.
  2. Unzip it inside /.vscode/extensions
  3. Restart Visual Studio Code
  4. You're done! Now, just type one template's name and voilà!

Atom

Features

Here is a list of features from the Atom Header comment extension:

  • Snippet available for the following languages
    • Java
    • C
    • C++
    • C#
    • Ruby
    • Python
    • HTML
    • CSS
    • SCSS
    • SASS
    • Javascript
    • PHP
    • XML
    • Yaml
  • Multi-languages (english, french, etc.)
  • An handy snippet to structure your code (complementary-information, see gif below for a demonstration)

Header comments Header comments features in Visual Studio Code

Complementray information Complementary information to structure your code

Installation

To install this extension:

  1. Download the latest release for your text editor/IDE.
  2. Unzip it inside /.atom/packages
  3. Restart Atom
  4. Check if enabled by going to : **File/Settings/Packages and search for header-comments
  5. You're done! Now, just type one template's name and voilà!

Credits

About

Add boilerplate code to display information and structure your code through comments! Chose between defferent templates for the headers! Commenting your code has never been easier.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published