CADiZ

Reference manual / Non-standard extensions to Z / Comments


Two additional kinds of commentary can be included in the mark-up of a Z specification, besides the informal text that can appear between paragraphs.

The first does not appear when the specification is typeset. Such comments are useful for disabling formal definitions without removing them from the mark-up. They are delimited by -- and the end of that line (in both troff and LATEX mark-ups). Additionally in the LATEX mark-up, they can be deliminated by % and the end of that line.

The second does appear when the specification is typeset. Such comments are typeset in a different font from the default used for formal text. cadiz requires such comments to be syntactically well-formed units, currently only predicates being permitted. The text of each comment must be written as a string literal.

Predicate = comment , STRING ;

The LATEX mark-up of is \comment. The troff mark-up of is comment.


IT 4-Jan-2002