On this page:
%comment
8.18.0.13

3.4 Comments🔗ℹ

A comment is a piece of text that is ignored by the AOE’s parser, but provides helpful information to someone looking at the code, such as yourself. Note that unless you want to preserve the comments in the generated script file, its generally advisable to use Racket’s comments instead.

procedure

(%comment text)  void?

  text : any/c
Creates a comment that will be embedded into the generated script file.

  • Comments can be nested. If you have a comment within a comment, the "sub comment" will not prematurely terminate the main comment, even if syntax highlighters indicate otherwise.

  • BUG (pre-DE): Comments within dead branches (see: Conditionals and Random Code) are NOT ignored. For more information, see this external article: Parser Pitfalls

Example:
#lang aoe2-rms
 
(%comment "This is a comment")
; This is also a comment, but it won't saved into the generated file