Skip to content

pedoc/BetterComments

 
 

Repository files navigation

Better Comments

Better Comments is a Visual Studio extension that gives you the ability to customize the font and opacity of your comments independently of the editor's font settings. It also adds four additional comment classifications, each classification with its own customizable foreground.

Build status

Download this extension from the Visual Studio Marketplace.

Download the latest build from VSIX Gallery.


Features

  • Additional comment classifications. Important, Question, Task, and Crossed.
  • Customizable foreground for each comment classification.
  • Customize the font settings and opacity of your comments.
  • Works with C#, F#, VB.NET, C/C++, JavaScript, Python, HTML, and XAML.

Comment Classifications

  • Use '!' for Important.
  • Use '?' for Question.
  • Use "Todo" (Case ignored) for Task.
  • Use 'x', 'X', or double comment for strikethrough (Crossed).

Or you can use your own custom tokens:

Sample1

Sample1

C#, F#, C/C++, and JavaScript

Sample1

VB.NET

Sample1

Python

Sample1

HTML/XAML (Works only with single-line comments)

Sample1

Multiline delimited comments (Works only in C#).

Sample1

Single-line delimited comments (Works in C#, F#, C/C++, and JavaScript)

Sample1


Custom Foreground Color for each Classification

  • You can set each comment classification foreground color to whatever you like.

  • You can also set a particular comment classification font weight to bold.

    Go to Tools => Options => Fonts and Colors

Sample1


Independent Font Settings

  • You can change the comments font settings without affecting the editor's font settings.

    Go to Tools -> Options -> Better Comments -> Font Options

Options

  • You can use whatever font you like.

Options

  • You can offset the comment font size relative to the font size of the editor. Make it larger or smaller.

Options

  • You can italicize comments.

Options

  • You can control the comments opacity.

Options

  • You can choose to color the "Todo" keyword only instead of the whole task comment.

Options

  • You can choose to underline the important comments

Options


Contribute


License

Apache 2.0

About

A Visual Studio extension for better comments.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%