Skip to content

Latest commit

 

History

History
96 lines (57 loc) · 2.6 KB

README.md

File metadata and controls

96 lines (57 loc) · 2.6 KB
Raw

Hermes Comments

Hermes Comments is a simple visual studio extension that I created to help structure C and C++ code (and other languages using // and /**/ comments). It's purpose is to automate the creation of more visually complex comments to structure and document code.

Features

Using shortcuts you can now turn a selected text into one of three possible formats, centered, left justified or subsection.

Left justified section titles:

left comment

Centered section titles:

left comment

Subsection titles:

left comment

To create a complex comment all you need is to highlight the desired text and use one of the shortcuts.

Support for modifying pre-existing comments

left comment

Separator bar to help distinguish important breaks in the code

left comment

The separator bar, created with alt+shift+; (; is the actual ';' key)

The shortcuts are:

  • alt+shit+p Creates a centered title
  • alt+shift+l Creates a left justified title
  • alt+shift+o Creates a subtitle
  • alt+shift+; Creates a separator line

Customizing the comments

You can decide which characters will be used to create the comments using the settings, just copy paste the following lines into your settings.json file:

"hermes-comments.maximum": 50,
"hermes-comments.fill": "-",
"hermes-comments.frame": "^",
"hermes-comments.title": "`",
"hermes-comments.separator": "$",

maximum is the maximum level of alignment , i.e the horizontal width of a title.

fill is the character used to fill the empty space in a frame.

When a comment contains the special characters @ or \ the frame is different.

title defines the character used for Doxygen documented frames.

separator defines the character used for the separator bar.

Known Issues

It won't handle comments whose length is bigger than the maximum length of characters (90 by default).

None more known, please report bugs, issues and feature requests to the github repository.

Release Notes

1.0.3

  • Modified the way the special comments are generated to prevent them from messing the Doxygen documentation.

1.0.2

  • Corrected a bug where spacing lines would get deleted

1.0.1

  • Added support for pre-existing comments.
  • Added the option to customize the characters used to make a frame.
  • Added a special frame that is created for comments containing the word author

1.0.0

Initial release of hermes comments

Enjoy!