comment

comment is accepted and discarded, so that scripts written for other output formats still run.

Syntax

comment text

text is the rest of the line. James keeps it as raw text and reads none of it.

What it does

The command has no effect on the mesh or on either file James writes. A script written for a different program may carry comment lines for that program’s output file, and James reads them without complaint.

When James applies it

When it is read, and then it is discarded. comment is legal in the Control, Part and Merge phases.

Diagnostics

None.

Example

The script tests/corpus/101-comment-verbatim-inert/input.tg, which make test runs:

block 1 2;1 2;1 2;0 1;0 1;0 1;
merge
comment general note about this mesh
verbatim
$ this dollar sign is not a comment marker here
endverbatim
neutral
write

The comment line and the verbatim block leave the IR the same as it would be without them. The mesh is one block, and the neutral file holds its 8 nodes and 1 element.

See also

• verbatim: a block of text that James discards.
• write: makes the file.