Unmaintained

Note that this extension is no longer maintained nor updated for this version of Visual Studio.
Mind switching to a newer version of Visual Studio to get a newer version of this extension.

Color.Comment

Visual Studio extension: Color C++ Comments.

Status

Branch	Build Status
2022
2019
2017

Description

Extension adds options to overwrite colors of certain C++ Comments.
Extension works in files of ContentType "C/C++", eg .cpp or .h files.

Usage

New entries will appear in Tools → Options → Environment → Fonts and Colors → Text Editor.
Each will begin with either C++ Comments: xor C++ Documentation: prefix.

• Edit their color values, until you want to keep extension default ones (listed below).
• If you don't want to change some attribute's color at all, set it's Item foreground value to Automatic.

Preview

Default Comments without extension	Color Comments with extension enabled

Options

New entries will appear in Tools → Options → Color.Comment. Each corresponds to different feature.
Options allows to disable, enable xor conditionally enable related features (coloring blocks of comments).

States

Full list of option states:

Details

Full list of options (Default state: Triple: Yes, but in triple slash comments only):

Note

Note that editing options does not take immediate effect to keep performance.
It requires reclassification, eg triggered by editing corresponding part of code.

Customization

Extension exposes several entries for customization across two kinds of comments to customize:

• C++ Comment prefixed ones refers to Regular comments (all but triple slash comments, eg //, //// or /////).
• C++ Documentation prefixed ones refers to Documentation comments (triple slash comments (that begins with ///).

Multiline comments are not supported. They will be untouched by this extensions, so shall remain default coloring.

Quotes

Quotes are line–wide blocks of comments which value begins with >.

Option

Option that enables quotes is C++ Comment: Quote.

Example

/// > Talk is cheap. Show me the code.
/// ~ Linus Torvalds

• Talk is cheap. Show me the code. is a quote and will be colored as C++ Comment: Quote.
• > is a quote mark and will be colored as C++ Comment: Quote: ">".

Code

Codes are line–wide blocks of comments which value begins with //.

Option

Option that enables quotes is Color line–wide code.

Example

/// Close connection.
/// Example usage:
/// // Connection.Close();
void Close();

• Connection.Close(); is a code and will be colored as C++ Comment: Code.
• // is a code mark and will be colored as C++ Comment: Code: "//".

Inline Code

Inline Codes are blocks of comments surrounded by Grave Accent (U+0060 ​`​) symbol.

Option

Option that enables quotes is Color inline code.

Example

/// Begin a new session.
/// \note On a debug mode, .Ping `10.0.0.2` upon session creation.
void Begin();

• 10.0.0.2 is an inline code and will be colored as C++ Comment: Inline Code.
• Both ​`​ are an inline code marks and will be colored as C++ Comment: Inline Code: "`".

References

References are inline mentions of entities (functions, variables etc.) in comments.
References consist of a single punctuation character immediatelly followed by an identifier.
For example: $Left references parameter Left; ^Floating references template parameter Floating.

Options

Options that enables references are:

• Color parameter references
• Color template parameter references
• Color member references
• Color static references
• Color local references
• Color macro references

Example

/// Cache with absolute value of .Result
unsigned int Cache_AbsResult = 0;

• .Result is a reference to Result member. Result will be colored as C++ Comment: Reference: Member.
• . is a member reference mark and will be colored as C++ Comment: Reference: Member: ".".

Details

Full list of references:

Headers

Headers are line–wide documentation commands for tools like Doxygen or Standardese.
Headers are enabled for triple slash C++ Documentation comments only (that begins with ///).
Headers begins with either @ or \, immediatelly followed by an identifier.

Details

• Headers format of Parameters and Template Parameters:
  [\\@] Identifier [ \t\v\f]* Identifier? ...? [ \t\v\f]* ([:=])? .*, ie \param Right Exponent value.
• Header format for all the rest:
  [\\@] Identifier [ \t\v\f]* ([:=])? .*, ie \short Description..

Examples

/// \short Description.
/// @details : More info.
/// \param Right Exponent value.
/// @tparam Floating = Type convertible to `float`.

Details

Full List of supported Headers:

Details

Full list of customizable Comment entries, with their default colors:

Newer versions

2019

• Branch: master
• Marketplace: Color.Comment

2022

• Branch: 2022
• Marketplace: Color.Comment (2022)