Markdownのコメント 質問する

Markdownのコメント 質問する

Markdownでコメントを書くにはどうすればいいですか?つまり、HTML出力に表示されないテキストを書くにはどうすればいいですか?マークダウンプロジェクト

ベストアンサー1

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

自分専用のコメントが必要な場合 (変換されたドキュメントの読者は、「ソースを表示」を使用してもコメントを表示できないようにする必要があります)、コア 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 パーサーで機能するはずです。(複数のリンクが定義されている場合や、リンクが定義されているが使用されていない場合の動作が厳密に指定されていない場合でも)。

おすすめ記事