Add Comments to the Citect​.ini File

You can add comments to your configuration file.

To add a comment to a section entry:

1. In the expandable tree pane, click the section to which you would like to add a comment.

2. The Parameter Details pane populates with the section information.

3. Type the comment in the Comment field.

   Or:

   Click Generate to insert the auto-generated comment "Added by {username} on {date}".

   The comment appears next to the section entry in the parameter tree.

   Note:
   • Comments can only be one line long. If the comment needs to be longer than one line, you should include it in the header of the file.
   • Using the Generate button replaces any existing comment made in relation to that section. To append comments type your text into Comment field.

To add a comment to a parameter entry:

4. Click the parameter in the expandable tree you want to add a comment to.

5. The Parameter Details pane populates with the parameter information.

6. Type the comment in the Comment field.

   Or:

   Click Generate to insert the auto-generated comment "Added by {username} on {date}".

   The comment appears next to the parameter entry in the parameter tree.

Note: Comments can only be one line long. If the comment needs to be longer than one line, you should include it in the header comment. See Enter Comments in the Header for details.

To enter comments in the header:

7. Choose View Header from the File menu.

8. The Header Information window opens. Comments added in this window are stored in the header of the configuration file.

   Note: Click Insert time/date to enter the current date and time where the cursor is placed in the text window.

9. Click OK to store the changes made to the header file.

See Also

Configure Citect.ini Parameters