More than 5 years have passed since last update.

マークダウン中にコメント行を入れる

Posted at 2015-04-29

マークダウン中にコメントを入れるには HTML コメントと同じ  が使えます（前後に空行が必要）。

↓↓↓↓↓↓↓↓

↑↑↑↑↑↑↑↑

実は上の矢印の間には

<!-- this is a comment. -->

というテキストが書かれていましたが、投稿すると見えなくなりました。
(Marked.js では HTML ソースに残りましたが、 Qiita ではソースからも消えてしまうようです。セキュリティのため？)

HTML 変換される段階でコメント行扱いになるため見えなくなるわけです。

下記リンクによると、通常の HTML コメントと区別するためにダッシュを３つ付けた
Stack Overflow: Store Comments in Markdown

<!---
  コメント
-->

という書き方も推奨されているようです。
PanDoc に変換するときに良いのだとか。

自作ソフトで他のマークダウンと互換性のある（というか無視される）独自タグを作りたい時にコメント行が使えるかもしれないと思って調べてみました。