Annotating ascii documentation files – Rockwell Automation 9323-PA2E APS SLC 500 Import/Export Utility User Manual User Manual

Page 85

Advertising
background image

Creating an ASCII Documentation File

6-7

Annotating ASCII Documentation Files

You can add comments anywhere in the ASCII documentation file. To add a single
line comment, place the comment after an exclamation mark (!). In this case, the
import utility ignores all text after the exclamation mark on that line.

You may also enter comments in the ASCII documentation file by inserting the
comment between two percent signs. (Tabs, carriage returns or spaces before and
after the percent signs are optional.) For example:

% This is a comment %

.

You may include one or more carriage returns in a comment.

Enter comments on a single line or several lines by themselves, or directly following
a complete ASCII command. If the import utility encounters a comment character
(% or !) between quotation marks, or a rung/instruction/address comment, it
considers the comment character as part of the rung/instruction/address comment.

The following example shows you how the import utility displays comments.
Notice that the comments used to document ASCII files only describe those files.
The import utility does not store these comments in the database.

!Begin import file comments with an exclamation

!mark. as you see here. You can document your A-B

!ASCII file as you would a program.

SYM

I:1.1/8 PALLET

!This is a comment after a complete line.

SYM

%This is a comment% I:1.1/5 %This is another comment% HI_ALARM

%This is a comment that spans

multiple lines%

Advertising