Main Features Download Documentation Resources

Comments

About

Comments play an essential role in documenting a program. The syntax of comments varies greatly between languages with each supporting line comments and/or block comments.

Block comments can cause issues if the comment contains the syntactic element that ends the block. As a result, template comments also support the character replacement logic of string literals.

Java Example
[Comment]
Text = // {Text}

Text Key

The text key is used to generate the syntax of the string literal. The {text} field contains a character sequence after the original string is modified by the various replacement keys.

Fields Contents
{text} The characters of the comment
Flags
None.

Replace Keys

String literals can contain up to 3 character replacement pairs. For example, in Pascal, block comments start with a { and end with a }. In the example below, all occurrences of } will be replaced by nothing (i.e. removed)

Pascal Example
[Comment]
Text = {{ {Text} }
Replace Char 1 = }
Replace By 1 =
Fields
None
Flags
None.