kozikowski wrote:Where do you put revision or date?
You can add any information you like as "comments", provided that you begin each comment line with a semicolon.
Most computer languages support "comments" (some languages call them "remarks"), as a way to annotate the code for the benefit of humans. This is most commonly achieved by adding a special character, or series of characters, to the start of the line before the comment.
General idea: When running the code, the computer disregards comments.
More precisely: The compiler / assembler / interpreter (depending on the computer language) disregards comments.
The Nyquist language uses a semicolon as its special "this is comment" character.
Example:
Code: Select all
; This line is ignored
;so is this
;;;;; and this
; and this
(hzosc 440) ; the first part of this line is run by Nyquist, but everything after the semicolon is ignored
; The code at the end of this line will be ignored because this line is "commented out" (hzosc 1000)
"Special" comments.
Audacity/Nyquist plug-in code has a number of "special" comments. As with all other Nyquist comments, they are ignored entirely by the Nyquist interpreter, but are read and used by Audacity. These are the "header" comments.
Header comments should be placed at the top of the script, and need to comply exactly with the specified form (syntax) described in
the documentation. If the syntax is incorrect (but the line does begin with a semicolon), then it is treated as a regular "comment" - it is disregarded.
kozikowski wrote:info;
??
Many years ago there was an
info "header".
The syntax was:
This header is now obsolete and treated by Audacity and Nyquist as an ordinary comment. That is, the line is disregarded.
In some obsolete versions of Audacity, the "info text" was displayed near the top of the plug-in GUI.