6.4.5 Comments

Page 72 of 800

Search internet

Text from a ""; escape sequence until and including the end of the line is ignored. So is text from a ""{ escape sequence until and including the first ""} escape sequence. This can be used for including comments in source texts:

   ""P baz               ""{ This defines the page name ""}
   ""R base              ""{ This references the base page ""}
   define "name" of baz  ""; This is a silly definition but
   as "qux" end define   ""; who cares

Above, do not use ""; in Line 1 and 2. The P and R escape sequences are terminated by the end of the line and ""; comments out the end of the line. If you really insist on using ""; you may insert an extra newline, either by inserting an explicit one or using an n escape sequence:

   ""P baz            ""n""; This defines the page name
   ""R base              ""; This references the base page

   define "name" of baz  ""; This is a silly definition but
   as "qux" end define   ""; who cares

You can put comments everywhere: Inside strings, in the middle of words, and so on. Here is an example:

   ""P baz
   ""R base
   define "na""{ Silly
   ""}me" of ""{ comments
   ""}baz as ""{ ruin
   ""}"qux" e""{ readability
   ""}nd define

Well there is one place you cannot put a comment: right after a double quote character. That is because an escape sequence comprises two or more double quote characters followed by a character which is not a double quote. Thus, if a comment is put right after a double quote character, the double quote character is considered part of the comment. But one can start strings by a ""- escape sequence and end strings by a "". escape sequence:

   ""P baz
   ""R base
   define ""-name" of baz
   as ""-""{Here comes the name""}qux"".""{That was the name""} end define

If you want to include an empty string, use a "". escape sequence:

   ""P baz
   ""R base
   define "name" of baz ""; Not a good name
   as "". end define    ""; but who cares

If you have aesthetic problems with that, use the '' construct defined on the base page instead:

   ""P baz
   ""R base
   define "name" of baz ""; Not a good name
   as '' end define     ""; but who cares

The number of double quote characters in an escape sequence is insignificant so that ""; and """"; have the same effect. As an exception, the number of double quote characters in a closing """"} must match the number in the opening """"{:

   ""P baz  """{ The ""} and ""{ escapes have no effect here """}
   ""R base
   define "name" of baz as "qux"

Page 72 of 800

Search logiweb.eu