^FX - Comment
Marks text as a comment so it is not printed.
^FX starts a comment. The text after it has no effect on the label, so ^FX
documents a format for a later reader. The comment ends at the next caret or tilde,
not at the end of the line.
Syntax
^FXcSupport
Every documented parameter renders the same output Labelary produces.
Labelary renders this command.
Parameters
cComment textoptional · textText to ignore.
- Default
- empty
- Invalid value
- not possible — any value is accepted. The comment ends at the next caret or tilde, so a comment with either character silently resumes parsing mid-sentence. This is the most common way a stray
^in prose breaks a label. - Test coverage
Behavior
The comment ends at the next command prefix, so a caret or tilde inside the prose
resumes the parse in the middle of a sentence. ^FXsee ^FD above is not a comment
that contains ^FD. It is a comment, then a field-data command whose data is
above. Keep prefixes out of comments, or change them first with ^CC and ^CT.
A comment is not a field, but the guide advises ^FS after it, and that costs
nothing. ^FS closes any field around the comment, which keeps a comment between
^FO and ^FD separate from the field. A newline is not part of the comment: a line
break inside one is harmless, and only the next prefix ends it.
Tested behavior
Example
Comments between fields, and one whose text deliberately avoids a caret:
^XA
^FXShipping label, revision 3^FS
^FO40,30^A0N,30,30^FDACME LOGISTICS^FS
^FXconsignee block starts here^FS
^FO40,80^A0N,24,24^FB600,3
^FD221B Baker Street\&London\&NW1 6XE^FS
^XZ
Related commands
^FDField DataSupplies the text or barcode content of the field.^CC / ~CCChange CaretChanges the character that introduces a format command.^CT / ~CTChange TildeChanges the character that introduces a control command.