yml(yaml) コメントアウトする

yml(yaml)ファイルを、コメントアウトする手順を記述してます。「#(シャープ)」で可能です。複数行コメントアウトすることはできません。YAMLはDocker Compose、Kubernetes、Ansible、GitHub Actions、CI/CD設定などで広く利用されている設定ファイル形式です。この記事では、YAMLでコメントアウトする方法について解説します。

コメントアウト

コメントアウトするには、「#(シャープ)」を使用します。

# コメント

version : "3" # コメント
services:

# コメント
  db:
    image: mariadb:latest
    restart: always
    ports:
      - 3308:3306
    volumes:
      - "./mysql:/var/lib/mysql"
      - "./initdb.d:/docker-entrypoint-initdb.d"
    environment:
      - MYSQL_ROOT_PASSWORD=pwd
      - MYSQL_DATABASE=test
      - MYSQL_USER=user
      - MYSQL_PASSWORD=pwd

複数行は、コメントアウトできないので「#」を行ごとに使用する必要があります。

複数行をコメントアウトする

YAMLでは、複数行コメント専用の構文は用意されていません。

そのため、コメントアウトしたい行ごとに「#」を付けます。

# version: "3"
# services:
#   web:
#     image: nginx

他のプログラミング言語のような以下の記述は使用できません。

/*
コメント
*/

Docker Composeでコメントアウトする

docker-compose.ymlでも同じように「#」を使用します。

services:
  web:
    image: nginx

    # ports:
    #   - "80:80"

    restart: always

ポート公開設定を一時的に無効化したい場合などに利用できます。

Kubernetes YAMLでコメントアウトする

Kubernetesのマニフェストファイルでも同じです。

apiVersion: v1
kind: Pod

metadata:
  name: sample

spec:
  containers:
    - name: nginx
      image: nginx

      # imagePullPolicy: Always

設定値を一時的に無効化したい場合に便利です。

行末コメントを記述する

YAMLでは、設定値の後ろにコメントを記述することもできます。

version: "3" # Docker Composeのバージョン

ただし、長いコメントを記述すると可読性が低下するため注意します。

コメントアウトとインデントに注意する

YAMLはインデントによって構造を管理しています。

コメントアウト後にインデントが崩れると、設定ファイルの可読性が悪くなります。

services:
  web:
    image: nginx

    # ports:
    #   - "80:80"

    restart: always

コメントアウトした後も、元のインデントを維持することをおすすめします。

VSCodeで複数行をコメントアウトする

Visual Studio Codeでは、複数行を選択してショートカットを使用することでコメントアウトできます。

Windows

Ctrl + /

Mac

Command + /

選択した行の先頭へ自動的に「#」が追加されます。

まとめ

YAMLでコメントアウトする場合は、「#」を使用します。

# コメント