Comments in PML Files
- Last UpdatedOct 21, 2022
- 1 minute read
Comments are additional text included in a PML file for the benefit of someone reading the PML code.
The PML processor ignores comments and so they do not affect the way the code executes.
For a simple one-line comment, begin the line with - - (two dashes) or $* (dollar and asterisk).
- - This is a new-style PML comment
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$* The following lines calculate the new angle
You can also use $* to add an inline comment to any line of PML:
|
!Z = !X + !Y |
$* You are assuming both !X and !Y are REAL. |
A comment may extend over several lines provided it is enclosed in the escape sequences $( and $).
$( A comment containing
more than one line $)
A comment of this kind can be used temporarily to comment-out lines of PML to prevent them from being executed, but without deleting them from the file:
$(
skip if (!X EQ !Y)
$)