; – Comments
The commands described here are only available when writing a standalone program.
The ( ; ) symbol tells the A-Script compiler to ignore the text following it, or the comment. Comments are brief explanatory notes added to code for the benefit of those reading it.
Standalone ;
Syntax:
Write:
; [comment]
|
Where: [comment] is any text |
Reply:
There is no reply for this Command
Example:
Write:
HSPD=20000 ;Set high speed to 20,000 pulses/sec * ; tells the compiler the text that follows is a comment and to ignore it .
Notes:
- Commenting Guidelines
- The following table provides general good programming guidelines for what types of comments can precede a section of code. These are suggestions; A-Script does not enforce rules for adding comments. Write what works best, both for you and for anyone else who reads your code.
|
Comment type |
Comment description |
|
Purpose |
Describes what the code does (not how it does it) |
|
Assumptions |
Lists each variable, or other element accessed by the procedure |
|
Effects |
Lists each affected variable, control, or other setting, and the effect it has (only if it is not obvious) |
|
Inputs |
Specifies the purpose of the argument |
|
Returns |
Explains the values returned by the subroutine |
See also:
Standalone Programming Commands