Comments

In ELCL, comments are used to annotate the configuration without affecting the document’s structure or content.

comment             ::= HASH TEXT*
end_of_line         ::= spacing comment? line_break
# A comment in the first line.
[main]       # A comment after an element.
value:       # Unicode → but no control characters
    "text"   # Comment

Rules

  1. Start: A comment begins with the hash character (#).

    # Comment
    
  2. No Control Codes: A comment may contain any characters, except for control characters, with the exception of the tab character (\t).

    # → Most Unicode is allowed 👍 ←
    
  3. End: A line break terminates the comment.

    #           end of comment →
    [no_comment_anymore]
    

Implementation Recommendations

  1. Parsers should completely ignore comments during parsing.

  2. Comments must not influence the document’s content or structure in any way.

Features

Feature

Coverage

core

The full syntax outlined in this chapter is part of the core language.

Errors

Error Code

Causes

Character

Raised if a comment contains a control character.