Code Commenting

Delisa Mason edited this page Aug 29, 2011 · 2 revisions

Toggle Line Comment

Menu: Edit > Formatting > Toggle Block Comment

Shortcut: Ctrl+/

Toggles the current selection from commented-out to uncommented. Each line is checked for the current single-line comment character(s). If the line is currently commented then the comment character is removed, otherwise the line is prepending by the comment character(s).

Toggle Block Comment

Menu: Edit > Formatting > Toggle Block Comment

Shortcut: Ctrl+.

Toggles a comment characters which wrap the current selection or line.

Extending this Plugin

If a particular language isn't supported (yet), you can add support for it by defining the comment characters in a comment_extension.json file in ~/.redcar or [project_path]/.redcar like so:

{
    "C++": {
        "line_comment" : "//",
        "start_block"  : "/*",
        "end_block"    : "*/"
    },
    "Perl": {
        "line_comment"    : "#"
    }
    ...
}

and remember to send a pull request for any languages you want to add. :)

Note

  • The use of the internal comment library is hopefully temporary, and use of TextMate bundle characters should happen soon.
  • The RSense plugin has the same keymapping as Toggle Line Comment (not sure how to handle this, yet)
  • An option to disable the warning when using default comment strings is in the plugin preferences, as well as settings for the defaults

‹‹ Back to User's Guide

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.