Skip to content

Comments ​

Write an editorial comment between /* and */. The renderer omits comments from reader content.

Multiline Comments ​

Use /* */ for comments:

sevenmark
Text before comment /* This is a
multiline comment
that spans multiple lines */ text after comment.

Comments can appear in parsed content, including table cells, list items, and folds. Inside raw code or literal content, the same characters remain text.

Comments in Complex Structures ​

Put comments inside parsed content:

sevenmark
{{{#list #type="numeric"
[[First item]]
[[Second item /* inline multiline comment */ with continuation]]
[[Third item]]
}}}

/* This is a comment explaining
   the structure of this wiki page:
   - Category classification
   - Headers with different levels
   - Mixed formatting styles
   - Nested complex elements
*/

Editor notes ​

Use #editor-note for an editor-only annotation:

sevenmark
{{{#editor-note
Check the source citation before the next update.
}}}

The parser preserves static markup in the note for editor tools. The evaluator does not execute bindings, includes, or data queries inside it. The renderer keeps the annotation out of reader content.

Comment Usage Guidelines ​

  • Use comments to explain complex markup structures
  • Comments are useful for temporary notes during document editing
  • The renderer omits comments from reader content
  • Comments can appear inside nested parsed structures
  • Code and literal bodies do not interpret comment markers
  • Nested comments are not supported (you cannot put /* */ inside another /* */)