Editing formation options

You can use the Formation tab to edit the structure of autocomments that are inserted into changed lines.

About this task

To edit the formation options, complete the following steps:

Procedure

  1. In the dialog box (for the type of language profile that you want to edit), click the Formation tab.
    Formation tab
  2. To specify a method for padding the base autocomment to comply with the maximum required length (specified in the maximum length field), do one of the following:
    • Click the Space radio button to use spaces to pad the base autocomment.
    • Click the Character radio button, and then type the single character that you want to use to pad the base autocomment.
  3. From the Pad Mode drop-down list, select one of the following values:
    • Outside - inserts the selected pad space or character outside of the Append Start and Append End characters.
    • Inside - inserts the selected pad space or character between the Append Start and Append End characters.
    • None - does not insert any padding to make all autocomments comply with the maximum length.
  4. In the Append Start field, type the string of characters that you want to prefix to all autocomments used in the programming language targeted by the selected language profile. For example, if all comments in the programming language start with // then type //.
  5. In the Append End field, type the string of characters that you want to append to the end of all auto comments used in the selected language profile.
  6. To enforce a minimum length that all autocomments must adhere to, select a value for the minimum length from the Minimum Length list.
    Tip: The length of the autocomment is determined after all of the padding and append characters have been added.
  7. To ensure that autocomments do not exceed a certain length, select a value for the maximum length from the Maximum Length list.
    Tip: The length of the autocomment includes the Append Start, Append End, and padding characters.
  8. To specify characters that you do not want to include in the base autocomment, type the character in the Add field, and then click Add to add the character to the Invalid Characters list.
  9. Click Apply to save your selections in the Formation tab.

Results

The Sample Comment group provides an example of how your autocomment will appear when it is inserted into changed lines.