ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

ASPComment

by danielsd ST2/ST3

Allows users of SublimeText2 to comment selections with single quotes

Details

  • 2014.01.26.23.43.52
  • github.​com
  • github.​com
  • 6 years ago
  • 32 minutes ago
  • 7 years ago

Installs

  • Total 4K
  • Win 3K
  • OS X 506
  • Linux 192
Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24
Windows 0 1 0 0 0 0 0 0 0 1 2 0 0 0 0 0 2 0 0 0 0 0 0 0 1 2 1 0 0 0 2 0 0 0 0 1 1 1 0 0 0 0 0 0 1
OS X 0 0 0 0 0 1 0 0 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Description

ASPComment is a plugin for Sublime Text that allows for multi-line commenting with single quotes, a convention used in Classic ASP, VbScript, and Visual Basic. Though Sublime Text has a line commenting shortcut built in, it only supports HTML style comments for “ASP (HTML)” syntax and offers no support for VbScript or Visual Basic, which do not work for ASP blocks. Furthermore it does not (natively) support VbScript or Visual Basic syntax highlighting and contexts.

ASPComment provides this functionality so that programmers of any language requiring single quote comments can enter comments with ease.

Installation

  1. Use the SublimeText2 Package Manager to install ASPComment.

  2. You can manually install the package by downloading the zip file and extracting it to the location given in the documentation.

Commands

The default keymappings can be viewed by selecting Preferences > Package Settings > ASPComment > Key Bindings - Default from the SublimeText toolmenu. Changes to the keyboard shortcuts should be added to the corresponding “Key Bindings - User” file to override the default mappings rather than erase them.

Note: By default, if no selection is made, any performed action is applied to the line the cursor is currently on.

Add Comment

asp_comment_add_comment

Add a single quote (') to the front of each line in the current selection. Selected lines already starting with a single quote will be ignored. Also note that empty lines are not commented.

Remove Comment

asp_comment_remove_comment

Remove a single quote ' from each line in the current selection that starts with a single quote (ignores whitespace). Any lines without a leading single quote are unmodified.

Toggle Comment

asp_comment_toggle_comment

Toggles comments on the current selection. If there is a single uncommented line, then the entire selection is commented. If all lines are commented, the comments are removed. Also note that empty lines are not commented.

Configuration

ASPComment has three settings which modify its behavior. These settings can be modified by adding them to the file found at Preferences > Package Settings > ASPComment > Settings - User with the desired value.

allow_double_comments

When this setting is true and the asp_comment_add_comment action is performed, lines already starting with a single quote will still receive an additional single quote.

comment_empty_lines

When this setting is true, empty lines will receive a single quote when asp_comment_add_comment or asp_comment_toggle_comment are performed.

comment_after_indent

When this setting is true and the asp_comment_add_comment action is performed, the single quote will be added after any leading whitespace. This preserves the line's indentation, which can be useful for some Sublime features (such as code folding).