Highlight specially marked comments in different colours to make notes, warnings, TODOs, and annotations stand out while coding. And it doesn't affect Doxygen or JSDoc. MarkDown Delimiters are also supported.
Features
Styled Comments applies colours only inside real comments (line comments and block comments) and supports many languages and even .txt files (#;).
Example for text files:
Simple Markdown support
You can use Markdown delimiters (`, *, **) to format words like Markdown. This is supported with line highlighters/decorators ( ?, *, !, @, $, & , #, %, ~, `, ^).
However the comment line must start with any non-Alphanumeric symbol. If you have a Alphanumeric (abcd...,123...) in front of the comment line then you'll have use a Full stop(.). [ period in american English ]
Supported Decorator symbols
| Symbol |
Meaning |
Style |
? |
Question / uncertainty |
Blue |
* |
Important note |
green |
! |
Warning / alert |
Red |
@ |
Mention / reference |
Yellow |
TODO: |
Task / reminder |
Bold + yellow |
$ |
Cost / money related |
Purple |
& |
Connection / related info |
Brown |
# |
Tag / category |
Orange |
% |
Performance / metrics |
Lime green |
~ |
Approximate / soft note |
Pink |
` |
Code / technical detail |
Blue |
^ |
Improvement / optimization |
Teal |
Support
Currently This supports the following languages id(s) :
dartcsharpjavagogroovyccppasmnasmllvmgasrustzigodinpowershellshellscriptpythoncmakeluajsoncsqlhtmlcssplaintextjavascripttypescriptjavascriptreacttypescriptreactphp
Usage
Simply place one of the supported symbols at the start of a comment.
// ? What should this function return?
// * This is really important!
// ! Warning: This might cause issues
// @ Remember to check with John
// TODO:Fix this bug
// $ This costs $50 per month
// & Related to the user authentication
// # Feature: Login system
// % Performance impact needs review
// ~ Approximately correct behaviour
// ` This involves low-level code
// ^ Can be optimized later
- Same can be done with block comments.
Simple Markdown
- use
` delimiter for highlighting a single word Green
- use
* delimiter for highlighting a single word Purple and italic
- use
** delimiter for highlighting a single word Gold and Bold
Known Issues
* Decorator specifically requires that you write like:
// *
and not like this:
//*
contributions
I would love any help you can provide.
You can help by,
- Starring the project on Github
- Finding and reporting issues
- Suggesting possible fixes for known issues
😢 I'm sorry if there are issues that haven't been fixed, yet. I'm just a student and I'm not good at Typescript.
