Menu: Found in the TOOLS menu
Use the Comment command to insert a remark or explanation into the Analyzer Command Log without affecting processing or execution. Comment allows you to document a session, including such items as purposes, descriptions and other required explanations. You can use Comment in procedures or groups to add comments to the log.
It is good practice to include adequate documentation to help future users determine what has been done and the results.
By adding comments to procedures, subsequent users of procedures or Command Log output from the procedures will be able to:
| • | follow instructions for procedure use |
| • | understand the programming logic used |
| • | know who created the procedure, when the procedure was created and who and what changes have been made to the procedure subsquently |
| • | be informed of what output is created |
By default, comment lines are recorded in the Command Log at the time you enter them. In a procedure, you can right-click and select “Capture Commands” so that comments are recorded as part of the procedure file. They are included in the log file at the time the procedure is run and displayed at the appropriate point in the results.
COMMENT comment-line
or
* comment-line
or
COMMENT
comment-line
comment-line
...
END or blank line
The comment-line is a line of text entered into the Command Log or a procedure.
When you specify a COMMENT or an asterisk “*” followed by a comment-line, Analyzer treats the line as a single comment.
When you specify a COMMENT or an asterisk “*” alone on a line, directly followed on subsequent lines by one or more comment-lines, Analyzer treats this as a multi-line comment. When you specify a multiple-line comment, you must place either a blank line or an END command after the last comment-line to indicate that the comment has terminated. If not, Analyzer treats all subsequent command lines as additional comment-lines.
At the appropriate point in a procedure created to get a basic overview of inventory before an inventory count, enter the following into the Comment text box from the Tools menu:
INVESTIGATE ANY NEGATIVE QUANTITY ON HAND VALUES.
After executing the procedure, the comment appears in the Command Log.
On the command line, enter:
COMMENT INVESTIGATE ANY NEGATIVE QUANTITY ON HAND VALUES.