Muncher sigils are groups of symbol chars that indicate the start or end of parts of the code that allow the occurrence of characters following no particular structure (such as strings or comments) -- thus the name "munchers". Its concrete strings are conformed by Symbol chars -- see SymbolChars documentation.

It constitutes one of the elements of the WordsDef interface.

There are two kind of munchers: string constants and comments. The elements in this interface provide the sigils needed for those two types: string delimiter chars to delimit string constants, and line comment openers, paragraph comment openers, and paragraph comments closers.

  • Strings are groups of any character surrounded by string delimiters. StringDelimiterChars allows to specify which are those characters.
  • Line comments are groups of any character different from a line separator char, started by a LineCommentOpener and finished by and line separator char. They are called "line" comments because they may not span more than one line.
  • Paragraph comments are groups of any character surrounded between a ParCommentOpener and the corresponding ParCommentCloser. They are called "paragraph" comments because they can span on one or more paragraphs with several lines. The arrays specifying openers and closers must be of the same size, and the closer in a given position closes the paragraph comment started by the opener in the same position in the other array.
interface MuncherSigils {
    LineCommentOpenerSigils: string[];
    ParCommentCloserSigils: string[];
    ParCommentOpenerSigils: string[];
    StringDelimiterChars: string;
    StringEscapeChars: string;
    StringEscapeSigilChars: string;
}

Properties

LineCommentOpenerSigils: string[]
ParCommentCloserSigils: string[]
ParCommentOpenerSigils: string[]
StringDelimiterChars: string
StringEscapeChars: string
StringEscapeSigilChars: string