Comment Templates
A comment template represents a pattern including custom text, that can be
inserted into a code window when a certain comment type insertion is requested.
Besides simple text (the static part of the pattern) a comment template can
include standard parameters that will
be replaced with different values at the insertion time (the dynamic part).
Type of comments used by the CodeSMART commenting tools:
-
Header comments used
to place descriptive header comments at the top of components and procedures
(members). This group includes:
- Module Header comments
- Procedure Header comments
-
Embrace-type comments
(block comments) used to place comments above and below a block of code
lines. This group includes:
- 'Added by' comments
- 'Modified by' comments
- 'Removed by' comments
- Custom comments
-
Other comments. This group
includes:
- Inline comments
To customize the comment templates:
-
Click Customize Current Templates on the Comments popup from the
Code Edit Tools toolbar or select the same entry in the CodeSMART main
menu (quick toolbar
and menu references are available).
in order to display the Comment Templates Manager.
-
Select the type of comment you want to modify from the left-hand tree.
The Defined Templates combo-box is filled with all the templates that
are available for the selected category.
-
Optional. You can create a new template and respectively rename
or delete the selected template by using the corresponding toolbar buttons.
Templates that start with "<Default..." cannot be renamed or deleted.
-
In the Template Contents text box insert the template contents. A template can
contain any of the available standard parameters from the corresponding popup menu.
Each line must be explicitly marked with one of the comment signs, i.e. "'"
or "REM".
-
Click Save to preserve the changes made to the current template.
Note
-
The selected template in a category will be used as the default template when
a comment, of that type, is inserted.
See Also
Back To Top
|