We can add comments to our Asciidoc markup. The comments will not be added to generated output. We can add both single and multiline comments in the markup. Single line comments start with a double slash (
//). Multiline comments are enclosed in a block of four forward slashes (
The following sample markup defines Asciidoc markup with comments:
= Asciidoctor comments // Paragraph with some text. Writing documentation is fun with Asciidoctor. * Item A * Item B // Divide lists with a single line comment. // Now we have two lists, otherwise it would // be a single list with 4 items. * Item 1 * Item 2 //// With four forward slashed we can start a multiline comment. And we close it with another four forward slashes. //// Asciidoc is really like _programming_ documentation.
When we generate HTML output we don't see any of the comments, not even in the HTML source:
Written with Asciidoctor 1.5.0.