.CM (Comment)

The .CM (Comment) control word places comments within a HELP file. Comments are useful for:
  • Tracking files

    This is a useful way for you to keep track of your changes to HELP files. You can include a comment that gives your name, the date and reason you created a file, and a future date when the file can be erased. HELP does not display any lines in a HELP file beginning with .CM. Therefore, you can include information about any alterations you have made to your HELP files in the files themselves.

  • Documenting formats

    If you use a special format in a HELP file that can be accessed by other people, you may want to place notes within the file explaining how to update the file.

  • Place-holders

    If a file is incomplete, you may want to put comments in the file where information should be added later.

For example, you could add the following to your HELP file: 
.CM Remember to change the date.
You would only see the line above when you were editing the HELP file.

You can also use comments to store unique identifications for locating a specific region of the file during editing.

Note that comments cause a format break. Comment lines are retained in the formatted file and do not appear when the HELP file is displayed. They are not removed by the HELPCONV command.