Markdownのコメント

マークダウンファイルにコメントを保存するための構文は何ですか（ファイルの先頭にあるCVS $ Id $コメントなど）。マークダウンプロジェクトには何も見つかりませんでした。

以前に提案されたすべてのソリューション（特定の実装を必要とするものを除く）では、コメントが表示されなくても、出力HTMLにコメントが含まれると思います。

自分だけのコメントが必要な場合（変換されたドキュメントの読者は、「ソースを表示」してもそれを表示できないはずです）リンクラベル（参照スタイルリンクで使用）を（ab）使用できます。コアMarkdown仕様で利用可能：

http://daringfireball.net/projects/markdown/syntax#link

あれは：

[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

または、さらに進むことができます：

[//]: <> (This is also a comment.)

プラットフォームの互換性を向上させる（および1つのキーストロークを節約#する）ために、<>次の代わりに（正当なハイパーリンクターゲット）を使用することもできます。

[//]: # (This may be the most platform independent comment)

可搬性を最大にするには、このタイプのコメントの前後に空白行を挿入することが重要です。これは、一部のMarkdownパーサーが、定義が通常のテキストに対してブラッシュアップされるときに正しく機能しないためです。Babelmarkを使用した最新の調査では、前後の空白行がどちらも重要であることを示しています。一部のパーサーは、前に空白行がない場合にコメントを出力し、一部のパーサーは後に空白行がない場合に次の行を除外します。

一般に、このアプローチはコア仕様の一部であるため、ほとんどのMarkdownパーサーで機能します。（複数のリンクが定義されているとき、またはリンクが定義されていても使用されていないときの動作が厳密に指定されていなくても）。

私は次のような標準のHTMLタグを使用します

<!---
your comment goes here
and here
-->

トリプルダッシュに注意してください。利点は、TeXまたはHTML出力を生成するときにpandocで動作することです。詳細については、pandoc-discussグループを参照してください。

この小さな研究は、マグナスによる答えを証明し、洗練さ せます

最もプラットフォームに依存しない構文は

(empty line)
[comment]: # (This actually is the most platform independent comment)

どちらの条件も重要です。

1. 使用する#（しない<>）
2. コメントの前に空行があります。コメントの後の空行は結果に影響を与えません。

厳密なMarkdown仕様CommonMarkは、この構文で意図したとおりにのみ機能します（<>および/または空の行では機能しません）。

これを証明するには、John MacFarlaneによって書かれたBabelmark2を使用します。このツールは、28のMarkdown実装で特定のソースコードのレンダリングをチェックします。

（+—テストに合格しました— —合格-しませんでした?—レンダリングされたHTMLに表示されないガベージが残っています）。

• 13<> +、15- を使用した空行なし
• コメントの前の空行、<> 20 +、8 を使用
• <>20 +、8 を使用したコメントの周りの空行
• #13+ 1 を使用して、空の行はありませんか？14-
• #23+ 1 を使用して、コメントの前の空の行 ？4-
• #23+ 1 を使用してコメントの周りに空行を挿入しますか？4-
• 3つのハイフンを含むHTMLコメント 1+ 2？25- chlの答えから （これは構文が異なることに注意してください）

これは上記のステートメントを証明します。

これらの実装は、7つのテストすべてに失敗します。それらと一緒にレンダリング時に除外されたコメントを使用する機会はありません。

• cebe / markdown 1.1.0
• cebe / markdown MarkdownExtra 1.1.0
• cebe / markdown GFM 1.1.0
• s9e \ TextFormatter（Fatdown / PHP）

Jekyllまたはoctopressを使用している場合は、以下も機能します。

{% comment %} 
    These commments will not include inside the source.
{% endcomment %}

Liquidタグ{% comment %}は最初に解析され、MarkDownプロセッサがそれに到達する前に削除されます。訪問者は、ブラウザからソースを表示しようとしても表示されません。

別の方法は、様式化されたHTMLタグ内にコメントを配置することです。このようにして、必要に応じて表示を切り替えることができます。たとえば、CSSスタイルシートでコメントクラスを定義します。

.comment { display: none; }

次に、次の拡張されたMARKDOWN

We do <span class="comment">NOT</span> support comments

ブラウザに次のように表示されます

We do support comments

これはGitHubで動作します：

[](Comment text goes here)

結果のHTMLは次のようになります。

<a href="Comment%20text%20goes%20here"></a>

これは基本的に空のリンクです。もちろん、レンダリングされたテキストのソースでそれを読むことができますが、とにかくGitHubでそれを行うことができます。

Vim Instant-Markdownユーザーは使用する必要があります

<!---
First comment line...
//
_NO_BLANK_LINES_ARE_ALLOWED_
//
_and_try_to_avoid_double_minuses_like_this_: --
//
last comment line.
-->

マークダウンツールの数の増加によってサポートされている批評家マークアップも参照してください。

http://criticmarkup.com/

Comment {>> <<}

Lorem ipsum dolor sit amet.{>>This is a comment<<}

Highlight+Comment {== ==}{>> <<}

Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.

非eval、non-echoのRブロックにコメントを入れてみませんか？つまり、

```{r echo=FALSE, eval=FALSE}
All the comments!
```

私にはうまくいくようです。

開示：プラグインを作成しました。

質問は、特定のマークダウン実装を指定していないので、私が言及したいプラグインのコメントのためのpython-値下げ同じpandocコメントスタイルは、上述の実装します、。

<!--- ... --> 

Pandoc Markdown（Pandoc 1.12.2.1）では機能しません。コメントはまだhtmlで表示されました。以下はうまくいきました：

Blank line
[^Comment]:  Text that will not appear in html source
Blank line

次に+ footnote拡張機能を使用します。これは基本的に、決して参照されない脚注です。

以下は非常にうまく機能します

<empty line>
[whatever comment text]::

で 作成されたリンク参照はレンダリングされないため、そのメソッドは構文を利用して参照を介し
てリンクを作成し[1]: http://example.orgます。同様に、次のいずれも同様にレンダリングされません

<empty line>
[whatever]::
[whatever]:whatever
[whatever]: :
[whatever]: whatever

pandocの場合、コメントをブロックする良い方法は、pandocの作者が提案したように、yamlメタブロックを使用することです。私は、これは（少なくとも私の環境では他の提案された解決策の多くに比べて、コメントのより適切な構文の強調表示を与えることに気づいたvim、vim-pandocとvim-pandoc-syntax）。

htmlコメントはネストできないため、yamlブロックコメントをhtmlインラインコメントと組み合わせて使用​​しています。残念ながら、yamlメタブロック内でブロックコメントする方法はないため、すべての行を個別にコメントする必要があります。幸いなことに、ソフトラップされた段落には1行しかありません。

私のでは~/.vimrc、ブロックコメントのカスタムショートカットを設定しています。

nmap <Leader>b }o<Esc>O...<Esc>{ji#<Esc>O---<Esc>2<down>
nmap <Leader>v {jddx}kdd

私が使用し,、私のよう<Leader>-key、そう,bと,vはそれぞれ、コメントおよびコメント解除A段落。複数の段落にコメントを付ける必要がある場合はj,b、マクロ（通常はQ）にマップして実行<number-of-paragraphs><name-of-macro>（例3Q：（））します。コメントを外しても同じように機能します。

kramdown（Jekyll、したがってGitHub PagesのデフォルトであるRubyベースのマークダウンエンジン）には、拡張構文によるコメントサポートが組み込まれています。

{::comment}
This text is completely ignored by kramdown - a comment in the text.
{:/comment}

Do you see {::comment}this text{:/comment}?
{::comment}some other comment{:/}

これにはインラインコメントを許可するという利点がありますが、他のMarkdownエンジンに移植できないという欠点があります。

あなたが試すことができます

[](
Your comments go here however you cannot leave
// a blank line so fill blank lines with
//
Something
)

これを行うことができます（YAMLブロック）：

~~~
# This is a
# multiline
# comment
...

ラテックス出力のみで試してみました。他で確認してください。