SlickEdit Corev3.3 for Eclipse, User Manual

Page: 199 / 568

Commenting
SlickEdit
®
Core makes commenting your code easy. You can comment out selected text, or type the start
characters for a new doc comment and have the doc comment skeleton automatically expanded. SlickEd-
it Core also makes your comments easier to read by automatically wrapping them as you type. Existing
comments can be "reflowed" to match current comment wrap settings.
Commenting Blocks and Lines
Existing text in your code can be commented out (or uncommented) as follows:
• To comment out a selected code block, from the main menu, click Format
→
Comment Block (or use
the box command). This comments out the entire selection as a single block comment by surrounding
the block with comment characters you have specified in your comment settings.
• To comment out selected lines, from the main menu, click Format
→
Comment Lines (or use the
comment command). Each line in the selection is commented out as a single line comment. If there is
no selection, the current line is commented out. If using a block selection where there are partially se-
lected lines, comment characters are placed at the beginning and end of the selection. If using a char-
acter selection where there are partially selected lines, comment characters are placed based on your
settings. The comment characters that are placed to the left and right of the text are also specified in
your comment settings.
• To uncomment lines in a selection, from the main menu, click Format
→
Uncomment Line (or use the
comment_erase command). Surrounding line comment characters are removed from the line. If there
is no active selection, the current line will be uncommented. Uncomment Line only works for well-
formed comments, which means that every line in the selection is commented and that the comment
characters occur in the same column.
Whether you are creating a comment block or a comment line, if the selected text already contains com-
ments, another set of comment characters is added. SlickEdit
®
Core attempts to preserve the indentation
level of the code and any existing comments when adding or removing comment characters.
Comment Block and Line Settings
To specify the characters and other settings used for comment blocks and lines, from the main menu,
click
Format
→
Comment Setup (or use the comment_setup command). The Extension Options dialog
is displayed open to the Comments Tab . Select the extension you wish to affect from the Extension drop-
down list.
The Comment block group box provides eight fields to specify the characters used in your commenting
style. If you want to apply a comment with no additional decoration, fill in the upper-left and lower-right
fields with the characters to begin and end a block comment. To draw a box around the comment, fill in
additional characters in the other fields. For example, you might put an asterisk in each of the other fields
to draw a box of asterisks around the block comment.
The Comment line group box contains fields for you to specify the characters to be inserted at left and
Commenting Blocks and Lines
177