YAML-コメント

Now that you are comfortable with the syntax and basics of YAML, let us proceed further into its details. In this chapter, we will see how to use comments in YAML.

YAMLは単一行コメント*をサポートしています。その構造は、例の助けを借りて以下で説明されています-

# this is single line comment.

YAMLは複数行コメント*をサポートしていません。あなたが複数の行にコメントを提供したい場合は、以下の例に示すように行うことができます-

# this
# is a multiple
# line comment

コメントの特徴

YAMLのコメントの機能は以下のとおりです-

コメント付きブロックは実行中にスキップされます。
コメントは、指定されたコードブロックの説明を追加するのに役立ちます。
コメントはスカラー内に現れてはなりません。
YAMLにはハッシュ記号（＃）をエスケープする方法が含まれていないため、複数行の文字列内にコメントを生の文字列値から分割する方法はありません。

コレクション内のコメントは以下に示されています-

key: #comment 1
   - value line 1
   #comment 2
   - value line 2
   #comment 3
   - value line 3

YAMLブロックにコメントを付けるためのショートカットキーの組み合わせは Ctrl + Q です。

あなたが Sublime Text editor を使用している場合、ブロックにコメントするための手順は以下に記載されています-

ブロックを選択します。 LinuxおよびWindowsでは「CTRL +/」、Macオペレーティングシステムでは「CMD +/」を使用します。ブロックを実行します。

*Visual Studio Code Editor* を使用している場合、同じ手順が適用されることに注意してください。 YAMLファイルの作成には、ほとんどのオペレーティングシステムでサポートされ、開発者が使いやすいショートカットキーが含まれているため、 *Sublime Text Editor* を使用することを常にお勧めします。

Yaml-comments

YAML-コメント

コメントの特徴