Comments: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 13: | Line 13: | ||
</source> | </source> | ||
Comments can be nested | Comments can be '''nested'''. This can be useful, in particular, for temporarily removing parts of the model, e.g. during testing/debugging. | ||
<source lang=a4c> | <source lang=a4c> | ||
| Line 22: | Line 22: | ||
</source> | </source> | ||
Note that in some text-editors, nested comments can confuse the [[syntax highlighting]], but regardless of that, the nested comments will work correctly in the ASCEND parser. | |||
See also | |||
* [[NOTES]], and | |||
* in particular [[NOTES#Inline_notes|inline notes]], which are a better way to label variables because the labels can be collected programmatically and associated with the variable they are labelling. | |||
[[Category:Syntax]] | [[Category:Syntax]] | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
Latest revision as of 06:31, 12 December 2013
In ASCEND syntax, comments can be written within the special delimiters (* and *).
Example:
(* This model is very useless, because it doesn't have any equations in it yet. *) MODEL mymodel; d IS_A distance; (* pipe diameter *) h IS_A distance; (* change in height *) END mymodel;
Comments can be nested. This can be useful, in particular, for temporarily removing parts of the model, e.g. during testing/debugging.
MODEL mymodel; d IS_A distance; (* pipe diameter *) (* h IS_A distance; (* change in height *) --we don't need this any more *) END mymodel;
Note that in some text-editors, nested comments can confuse the syntax highlighting, but regardless of that, the nested comments will work correctly in the ASCEND parser.
See also
- NOTES, and
- in particular inline notes, which are a better way to label variables because the labels can be collected programmatically and associated with the variable they are labelling.