Placement settings

Edit online

Each language profile has its own set of options. The placement settings for each language profile determine where autocomments are inserted into changed lines.

In different types of files, you might want to place auto comments in different positions within changed lines. For example, in files that contain a restriction on the number of columns that are used, autocomments should be placed within a certain column range. You can also insert autocomments on top of old autocomments or at the end of changed lines.
Setting Description Value type Syntax
OnComments Determines if an autocomment should be inserted into a comment line. Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
OnBlanks Determines if an autocomment should be inserted into a blank line. Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
OnContinues Determines if an autocomment should be inserted into a line that contains a continuation character.
Note: This setting is only valid for the HLASM language profile.
The continuation column is 72; if this column contains any characters and the OnContinues option is set to NO, an autocomment is not inserted.		 Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
OnInvalidInstructions Determines if an autocomment should be inserted into a line that contains an invalid instruction.
Note: This setting is only valid for the HLASM language profile.
 Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
BlankBeforeStart Determines if an autocomment should be inserted into a line that contains a character in the column immediately before the StartCol. Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
InsertPos Specifies how to insert the autocomment into the changed line. For example, at a start column or at the end of a changed line. Number value; must be a positive integer. Must be a number between 1 and 6, inclusive:
  • 1 - insert at the end of the line.
    Note: Ignores column values.
  • 2 - insert at start column.
    Note: Existing text is moved over from the start column when the autocomment is inserted.
  • 3 - overlay in the column range.
    Note: Places the auto comment on top of existing text unless OvertypeExistingText is set to NO.
  • 4 - only adds the autocomment at the Start Col if it will not replace existing text.
    Note: If there is existing text and InsertAtEnd is set to YES, the autocomment is inserted at the end of the line.
  • 5 - only adds the autocomment at the Start Col if it will not replace existing text.
    Note: If there is existing text and this text has the AppendStart string, the autocomment replaces the existing text.
  • 6 - overlays the text in the column range; only replaces the existing text if it appears to be an old autocomment.
    Note: The AppendStart string determines if the text in the column range is an old autocomment. If OvertypeExistingText is set to NO, then the autocomment if not inserted on top of the existing text.
OvertypeExistingText Determines if the autocomment should overwrite existing text in the specified insertion columns. Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
StartCol Determines the starting column for the auto comment. If the Alignment option is set to Left, the first character of the autocomment is inserted into the StartCol.
Note: Auto comments cannot have values placed in both the start and end columns.
 Number value; must be a positive integer. Must be smaller than the EndCol value.
EndCol Determines the last column of the autocomment. If the Alignment option is set to Right, the last character of the autocomment is inserted into the EndCol.
Note: Auto comments cannot have values placed in both the start and end columns.
 Number value; must be a positive integer. Must be larger than the StartCol 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.
InsertDuplicates Determines if a check should be performed to verify if the autocomment has already been inserted on the current line. This check ensures that you do not insert the same autocomment multiple times on the same line.
Note: If this degrades performance, set this option to Yes so that the check is not performed.
 Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
InsertAtEnd Determines if the autocomment should be inserted at the end of the line when text already appears in the column range. Boolean value; must be set to one of the following:
  • Yes
  • True
  • On
  • No
  • False
  • Off
  
InvalidInstructions Determines if a check should be performed to verify if the line contains invalid instructions. If the line contains an invalid instruction and OnInvalidInstructions is set to NO, then the autocomment if not inserted.
Note: This setting is only valid for Assembler files.
 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 list of invalid instructions, where each instruction is separated by a space. For example, SPACE ASPACE EJECT CEJECT AEJECT TITLE