home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / forth / compiler / fpc / help / comment.hlp < prev    next >
Encoding:
Text File  |  1988-01-11  |  1.6 KB  |  55 lines
  1. \ COMMENT.HLP   Allow multiple line comments in files.  by Tom Zimmer
  2.  
  3. <comment:>      ( --- )
  4.         Primitive used by "comment:".
  5.  
  6. comment:        ( --- )
  7.         Start a multi-line comment. Patches <comment:> into RUN,
  8.         it then reads and throws away lines until "comment;"
  9.         is encountered.
  10.  
  11.         Here is an example of usage:
  12.  
  13.             comment: <- this marks the start line of a multi line comment.
  14.  
  15.                 this is a comment line somewhere in the middle.
  16.  
  17.             comment; <- this marks the end line of a multi line comment.
  18.  
  19.  
  20.  
  21. <.comment:>     ( --- )
  22.         A primitive used by ".comment:".
  23.  
  24. .comment:       ( --- )
  25.         Starts a multi-line print statment. All lines following the
  26.         ".comment:" line will be printed to the display until a
  27.         "comment;" is encountered.
  28.  
  29. <#if>           ( --- )
  30.         A primitive used by #IF.
  31.  
  32. #if             ( bool --- )
  33.         Starts a multi-line compiler directive. If the BOOL passed
  34.         to #IF is true, then the lines following #IF will be executed.
  35.         If the BOOL is false, then the lines following #IF up to the
  36.         #ENDIF, will be ignored.
  37.  
  38.         Here is an example of how #IF works:
  39.  
  40.         true    ( --- f1 )
  41.         #if     True flag passed, this comment needs no preceeding \
  42.             cr .( This statment printed due to TRUE flag in #IF statment.)
  43.         #endif
  44.  
  45.         false   ( --- f1 )
  46.         #if
  47.             .( This statment NOT printed due to FALSE flag in #IF statment.)
  48.         #endif
  49.  
  50.  
  51. #endif ;      \ just a noop for the #if TRUE case.
  52.         Ends a multi-line Compiler directive. See #IF.
  53.  
  54.  
  55.