Opaque Block Comment

A block of text of any length and in any location, treated as an opaque comment โ€“ that is, ignored in the final output and used solely to leave information for other project contributors.

Syntax

Any number of Unicode enclosed between /*โ€ฆ*/, optionally preceded by a valid comment tag.

Overview

NotationSimplified ASTPaper Output
/*TแถœแตŸ ๐‘†ร—๐‘*/Comment(๐‘†ร—๐‘, TแตฅแตŸ, Block)---
  • ๐‘† = any sign (Unicode character) โˆ‰ STOP_SET (cf. Technical Catalogue of Symbols) otherwise preceded by the escape character \.
  • ๐‘ = number of characters (represented by char or digits).
  • TแถœแตŸ = optional comment tag.
  • TแตฅแตŸ = validated optional comment tag.

Examples

NotationPaper Output
 
/*abc*/

EpiDoc Outputs

NotationEpiDoc (XML)
 
/*abc*/
<ab>
</ab>

Structural Analysis (Conceptual AST)

NotationAST
 
/*abc*/
Comment(Block, None, "abc")