Colored Comments

The Colored Comments plugin was designed to help create more readable comments throughout your code. It was heavily inspired by Better Comments by aaron-bond

Global Settings

The following are global settings for ColoredComments

• continued_matching - If enabled, the same match as the previous line will be applied to the next line if prefixed with a -

# TODO Highlighted as a TODO
# - This will also be highlighted as a TODO (Prefixed with a -)
# This will be an unhighlighted comment
# ! This is another comment
# - and again, continued highlighting

Version 2+

New Highlights

Add new tags easily with the following format. Keep in mind the following:

• identifiers: These can be plaintext or regex patterns. If they are regex be sure to set the is_regex property to true
• is_regex: Set this to true if your identifier is a regex
• priority: This setting is critical if you want to prioritize tag settings. Default: 2147483647
  • This should be used if there are multiple tags that could match on the same thing. An example of this would be "identifier": "*" and "identifier": "[\\*]?[ ]?@param" could both match on * @param because one is less precise. To avoid these conflicts you can give the [\\*]?[ ]?@param a higher priority such as "-1", Negative values get higher priority than positive values. If two or more tags get the same priority, they are treated as first come first serve type of matching.
• scope: Are built in colors from your current theme. Scope takes precedence over Color
• underline: Sublime API setting for region draws
• stippled_underline: Sublime API setting for region draws
• squiggly_underline: Sublime API setting for region draws
• outline: Sublime API setting for region draws
• color: Custom text colors
  • name: This is used when generating the scope for the color scheme
  • foreground: This is the text color
  • background: This is the background of the region, generally you'll want this to be your themes background color slightly changed background if your themes background is "rgba(1, 22, 38, 0.0)" this should be set like "rgba(1, 22, 38, 0.1)" for best results

Scope Examples

Taken from Sublime MiniHTML Reference

• region.background
• region.foreground
• region.accent
• region.redish
• region.orangish
• region.yellowish
• region.greenish
• region.cyanish
• region.bluish
• region.purplish
• region.pinkish

Example Tag

"Important":
        {
            "identifier": "!",
            "underline": false,
            "stippled_underline": false,
            "squiggly_underline": false,
            "outline": false,
            "color":
            {
                "name": "important",
                "foreground": "#cc0000",
                "background": "rgba(1, 22, 38, 0.1)"
            },
        }

Contributors

• TheMilkMan