マークダウンコメント

マークダウンは、世界で最も人気のあるマークアップ言語の1つです。 2004年にJohnGruberによって作成されたMarkdownは、プレーンテキストに書式設定要素を追加できる単純で軽量なマークアップ言語です。

Markdownはプラットフォームに依存せず、事実上すべてのアプリケーションで転送できます。 その結果、ブログ、ドキュメント、ノートブック、電子メールなどのWeb開発で広く使用されるようになりました。

Markdownはどのように機能しますか？

前述のように、Markdownはマークアップ言語です。 したがって、拡張子が.mdまたは.markdownで終わるファイルで作業します。 このファイルには、見出し、コードブロック、インデント、配置などの書式設定要素が含まれています。

マークダウンドキュメントは、マークダウンプロセッサまたはパーサーと呼ばれるアプリケーションによって処理されます。 次に、パーサーはフォーマットされたテキストを取得し、ドキュメントのHTMLを生成します。 その後、ブラウザまたはそれをサポートする任意のアプリケーションでHTMLドキュメントを表示できます。

次の画像は、このプロセスがどのように機能するかを示しています。

（この画像はフォームです マークダウンガイド。）。

以下のリソースで、Markdownがどのように機能するかについて詳しく知ることができます。

https://www.markdownguide.org/

マークダウンコメントとは何ですか？

マークダウンコメントは、マークダウンファイルに追加されたが、レンダラーアプリによって無視されたテキストを指します。 したがって、生成された出力にはマークダウンコメントは表示されません。

コメントは、ドキュメントの作成者にのみ表示され、結果のドキュメントには表示されない非表示のテキストをドキュメントに含める必要がある場合に役立ちます。

マークダウンコメントを挿入する方法

残念ながら、Markdownはコメントのネイティブサポートを提供していません。 ただし、インポートしたソリューションを使用して、マークダウンドキュメントにコメントを追加できます。

方法1

Markdownにコメントを追加するための最初の構文は、コメントテキストを角かっこで囲み、その後にコロン、スペース、ポンド記号を続けることです。

構文は次のとおりです。

角かっこ内のテキストはコメントとして扱われ、Markdownレンダラーによって無視されます。

例は次のとおりです。

上記の例では、見出し、段落、コメント、および別の段落を含む単純なMarkdown構文があります。

方法2

以下の構文では、Markdownドキュメントにコメントを挿入することもできます。

これは、コメントを追加するための最もプラットフォーム互換の形式と見なされています。

この構文の別のバリエーションは次のとおりです。

方法3

一部のMarkdownエンジンでは、2つのスラッシュをスキップして、以下の構文を使用できます。

方法4

以下の構文に示すように、マークダウンにHTMLコメントを含めることもできます。

人気のあるMarkdownアプリは、上記の方法をサポートしています。

方法5

Githubでは、以下の構文を使用してコメントを示すこともできます。

ただし、上記の構文は、従来は採用および使用されていなかったものです。

閉鎖

このチュートリアルでは、Markdownコメントにコメントを追加する5つの効果的な方法を発見しました。