LoginSignup

This article is a Private article. Only a writer and users who know the URL can access it.
Please change open range to public in publish setting if you want to share this article with other users.

More than 3 years have passed since last update.

YAMLにコメントを書くときの注意(真偽不明)

Last updated at Posted at 2020-07-04

2020.7.3 追記

  • 予定していた期日が過ぎたので削除するつもりでしたが、消してしまうのも何なので限定共有として保存

2020.2.22 追記

  • 一定数の方にストックされているようなのですが、この記事に記載している情報の真偽が不明な状態ですので、一定期間(3ヶ月くらい)後に削除します。

(注意:記事を書いたときのrubyのバージョン等を明記してなかったので不明ですが、以下の内容は YAML の仕様とは異なるようですし、現在のバージョンでは以下の内容は当てはまらない可能性ありますので、信用しないでください…)

間違い

hoge:
  fuga
  # piyo

あるいは

hoge:
  fuga # piyo

とすると"# piyo" の部分まで文字列として扱われる。

正しい

以下のようにキーの後、値が始まる前に記述する。

hoge: # piyo
  fuga
hoge:
  # piyo
  fuga

あるいは、インデントを下げて記述する。

hoge:
  fuga
# piyo

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up