Comment In Markdown

Comments

Some people need the ability to write sentences in their document files that will not appear in the rendered output(e.g. on the webpage or PDF).

The text is viewable by the author of the document,but it’s not printed in the rendered / proceed output. 

 

Comment In Markdown

Markdown doesn’t natively support comments,but several enterprising individuals have devised a solution.

To add a Markdown comment,place text inside brackets followed by a colon,a space,and a pound sign(e.g.,[comment]:#). You should put blank lines before and after a comment.

Example:

Here's a paragraph that will be visible.

[//]:#(This is a comment that will be hidden.)

And here's another paragraph that's visible.

To add a Markdown comment in the HTML code file,starts with a <!--- tag(left angle bracket followed by exclamation point,three dashes and white space) and ends with a --->tag(white space and three dashes followed by right angle bracket). These tags tell the browser that the text inside them as a comment. Some Markdown parsers support two-dash HTML comments,but the three-dash version is more universally compatible.

Example:

_italic text_

<!---

comments syntax

--->

***bold text**

Notes

• Beware it doesn't allow multi-line comments(at the time you are using several tools/markdown parsers) and each comment must appear on it's own line.
• Beware it doesn't allow inline comments(at the time you are using several tools/markdown parsers) and each comment must appear on its own line without the content.
• Several markdown parsers/tools only support single line block comment without multi-line comments

Bibliography

https://blog.hubspot.com/

https://docs.oracle.com/ ( manual book )

https://github.com/

https://www.jamestharpe.com/

https://www.markdownguide.org/