home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Tools / MorphOS / Epic4_mos / share / epic / help / 5_programming / comment < prev    next >
Encoding:
Text File  |  2002-10-28  |  1.5 KB  |  39 lines
  1. Synopsis:
  2.    comment [<anything>]
  3.  
  4. Description:
  5.    This is exactly what it says, a comment.  It does nothing.  It is useful
  6.    in scripts for explaining bits of code, adding disclaimers or copyright
  7.    notices, etc.
  8.  
  9.    There are also several symbolic comments.  Both the # and : characters
  10.    may be used to designate comments.  There is no functional difference
  11.    between any of them.  Additionally, EPIC supports C /* */ multiline
  12.    comments.
  13.  
  14. Examples:
  15.    These are some comments:
  16.       comment this was the first comment
  17.       # this is a newer comment
  18.       : this is a new comment too, but it isn't used much
  19.       /* this is an elite comment unique to EPIC */
  20.  
  21. See Also:
  22.    set(4) comment_hack
  23.  
  24. Restrictions:
  25.    In order to facilitate the use of older scripts (those designed for old
  26.    or non-EPIC clients), the default behavior is to recognize C-like
  27.    comments only if they start at the beginning of a line.  This allows
  28.    for '/*' sequence to appear in ECHOed text, etc.  This default can be
  29.    changed to the traditional C behavior by setting COMMENT_HACK off.
  30.    There is no restriction on where the closing '*/' may appear.  Also,
  31.    unlike C, a command may not begin before a comment, and end after it;
  32.    the /* */ effectively acts like a line terminator.
  33.  
  34. Other Notes:
  35.    Executing an alias whose name begins with a '*' by calling it as '/*'
  36.    will lose, as it will be interpreted as a comment.  The solution here is
  37.    to limit alias names to alphanumeric characters.
  38.  
  39.