Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

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

NotationConceptual 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")