Existing text in your code can be commented out (or uncommented) as follows:

Whether you are creating a comment block or a comment line, if the selected text already contains comments, 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.

Doc comments are specially formatted comments that are processed by tools that extract and present the information in a formatted manner. Doc comments follow a predefined structure, based on the programming language and the tool processing the comments.

SlickEdit® Core supports the most common doc comment formats (Javadoc, XMLdoc, and Doxygen). When you type the start characters for one of these comment formats and press Enter on a line directly above a function, class, or variable, SlickEdit Core can automatically insert a skeleton doc comment for that style.

To activate and configure automatic completion of doc comment skeletons, complete the following steps:

/**[CURSOR_HERE]*/
int setDimensions(int length, int width, int height) {
  ...
}

/**
 * [CURSOR_HERE]
 *
 * @param length
 * @param width
 * @param height
 *
 * @return int
*/
int setDimensions(int length, int width, int height) {
  ...
}

///[CURSOR_HERE]
int setDimensions(int length, int width, int height) {
  ...
}

/// <summary>
/// [CURSOR_HERE]
/// </summary>
/// <param name="length"></param>
/// <param name="width"></param>
/// <param name="height"></param>
/// <returns>int</returns>
int setDimensions(int length, int width, int height) {
  ...
}

/*![CURSOR_HERE]*/
int setDimensions(int length, int width, int height) {
  ...
}

/*! 
 * [CURSOR_HERE]
 * 
 * \param length
 * \param width
 * \param height
 * 
 * \return int
 */
int setDimensions(int length, int width, int height) {
  ...
}

Modifying Doc Comment Templates

To modify a doc comment template, from the main menu, click Window → SlickEdit Preferences → Languages, expand your language category and language, and click the Edit expansion button. The Doc Comment Editor dialog for the selected language opens. Click on the start characters for style of comments you want to use to view and edit the associated comment template.

The box on the left contains a list of doc comment start characters. The edit window on the right contains the expansion for the selected start characters. See Alias Escape Sequences for a list of special escape characters you can use inside doc comment templates, for example, to insert local function param names, types, and return types. See Doc Comment Examples for an example of each comment style.

Tip

You cannot add or delete doc comment templates using the Doc Comment Editor. You can, however, add a new doc comment expansion as a regular language-specific alias. See Creating a Language-Specific Alias for more information. All of the doc comment escape sequences will work as long as you expand the alias on a blank line above a function or class declaration.

When the cursor is inside of a string, if you press Enter to split the line, SlickEdit® Core can automatically align the string with the original string as well as insert the closing and opening quotes and, if necessary, operators. To set this option, click Format → Comment Setup (comment_setup command). The Options dialog is displayed open to the Comments screen. Select the option Split strings on Enter.

Comments can be set to automatically wrap to the next line as you type. This feature is available for C, C++, C#, Java, and Slick-C® files.

To activate comment wrapping, from the main menu, click Window → SlickEdit Preferences → Languages, expand your language category and language, then select Comment Wrap. Select the option Enable comment wrap, then select the type of comments you want wrapped (block comments, line comments, and/or doc comments).

The Comment Wrap screen also provides options to control how comments are wrapped. There are three types of width settings:

For more details on comment wrapping configuration, see Language-Specific Comment Wrap Options.