Inserting Embrace-Type Comments
Embrace-type (block) comments represent descriptive comments that are placed
above and below a block of contiguous code lines. They can be used
to pinpoint common properties of the lines belonging to the section of code they
'embrace'.
By using the CodeSMART commenting tools you can use four different types of block
comments:
-
'Added by' comments used to comment mark code lines that were inserted
in a project.
-
'Modified by' comments used to mark code changes and provide change history.
-
'Removed by' comments used to comment-out blocks of code.
-
Custom comments used to insert a custom comment line above and below
a code selection, good in situation when you want to mark a few code lines as
having a certain property.
To insert embrace-type (block) comments:
-
Open the project that contains the target file.
-
Open the code module of the component you want to insert the block-type
comments in.
-
Select a line or a section of code.
-
Click Embrace Comment <Added by.. at.. on..> (for example) on the
Comments pull down menu of the Code Edit Tools toolbar or select
the same entry in the CodeSMART main menu. Two comments will be inserted above
and below the previously select code.
The code that is actually inserted can be customized by using the Comment
Templates Manager.
See Also
Back To Top
|