Formation settings

Edit online

Each language profile has its own set of options. The formation settings for each language profile determine the formation of the actual custom autocomment.

When the autocomment feature is invoked, an initial base autocomment is provided. You can use the formation settings to specify the characters to append to the beginning and the end of all base autocomments.
Setting Description Value type Syntax
Minimum The minimum number of characters allowed in the auto comment, including append characters. Number value; must be a positive integer. Must be smaller than or equal to the Maximum value.
Maximum The maximum number of characters allowed in the auto comment, including append characters. Number value; must be a positive integer. Must be larger than or equal to the Minimum value.
Alignment Determines if the autocomment is left, center, or right-aligned in the column range. This setting is also used to determine which end of the base autocomment the padding is inserted in. Number value; must be a positive integer. Must be a number between 1 and 3, inclusive:
  • 1 - Left Align - first character of the autocomment appears in the StartCol.
  • 2 - Center Align - autocomment is centered in the desired column range.
  • 3 - Right Align - last character of the autocomment appears in the EndCol.
PadMode Determines if the autocomment will be padded with the PadChar to satisfy the maximum required length. Also specifies if the padding appears inside or outside of the append characters. Number value; must be a positive integer. Must be a number between 1 and 3, inclusive:
  • 1 - Inside - pad autocomments with the pad character between the base autocomment and the append strings. Padding is inserted according to the alignment setting.
  • 2 - Outside - pad autocomments with the pad character outside of the append strings. Padding is inserted according to the alignment setting.
  • 3 - None - do not pad autocomments.
PadChar Defines the character used to pad autocomments. Character value; must be one character. If the character is a space, enclose the space in double quotation marks.  
InvalidChars Defines the characters that are invalid in the base autocomment. A check is performed for invalid characters before adding append strings. String list value; must be a list of white-space delimited words. Each word that contains spaces must be enclosed in double quotation marks. Must be a string of invalid characters where each character in the string is an invalid character.

To use spaces in the string, enclose the entire string in double quotation marks. For example, "aeiou *".
AppendStart Defines the characters to append to the start of all base autocomments. It is recommended that you use the AppendStart characters as the comment delimiters for the language. String value; must be a string. If this string contains spaces, you must enclose it in double quotation marks. Must be a string where the string represents the characters to append to the start of the base autocomment.

To use spaces in the string, enclose the entire string in double quotation marks.
AppendEnd Defines the characters to append to the end of all base autocomments. String value; must be a string. If this string contains spaces, you must enclose it in double quotation marks. Must be a string where the string represents the characters to append to the end of the base autocomment.

To use spaces in the string, enclose the entire string in double quotation marks.