Before
[/]: / "Your comment here"
After
It exploit the “reference-style” link syntax (and workarounds various bugs) to make the egine fully ignore the comment line. So, contrary to a HTML comment, the comment won’t appear in the HTML code.
In order to work on any engine, the syntax must follow a lot of rules:
- The entire comment syntax must be in one line. A multi-line comments must be split into multiple comments.
- The comment line can only be preceded by the start of the document, an empty line or another link definition (another comment for example).
- The comment line can only be succeded by the end of the document, an empty line or another link definition (another comment for example).
- In the same line, nothing can precede the first bracket.
- The link ID (the text between brackets) must not be empty and must not contain any blank or special character (no space, no
\, etc.). - The link URL (the lonely slash after the colon above) must be surrounded by a spaces, must not be empty and not contain any blank or special character (no space, no
\, no<, no>, etc.). - The link URL must not contain
#. - The link title (the actual comment) must be surrounded US-ASCII quotes (
"). Even if specified by the original implementation, parentheses and'won’t work on many engine. - The link title (the actual comment) must not be empty and must no contain
",\or an end of line. - Obviously, this syntax won’t work inside a code block or a raw HTML block.