YAML-コメント

YAMLの構文と基本に慣れてきたので、さらに詳細に進みましょう。この章では、YAMLでコメントを使用する方法を説明します。

YAML supports single line comments。その構造は、例の助けを借りて以下に説明されています-

# this is single line comment.

YAML does not support multi line comments。複数行にコメントを付けたい場合は、以下の例のようにできます。

# 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。常に使用することをお勧めしますSublime Text Editor ほとんどのオペレーティングシステムでサポートされているYAMLファイルを作成し、開発者向けのショートカットキーが含まれています。