1. ホーム
  2. yaml

[解決済み] YAML の標準的な命名規則とは?

2022-08-24 12:37:52

質問

新しいYAMLファイルを設計していますが、最も標準的な命名スタイルを使用したいと思います。 それはどちらでしょうか?

ハイフン付き?

- job-name:
    ...

lower_case_with_underscores?

- job_name:
    ...

キャメルケースは?

- jobName:
    ...

どのように解決するのですか?

周囲のソフトウェアが指示する規格を使用する。

たとえば、私の現在のプロジェクトでは、YAMLファイルはPythonの属性のためのデフォルト値を含んでいます。 YAMLで使われる名前は関連するPython APIに現れるので、この特定のプロジェクトにおいて、YAMLの名前はPython APIに従わなければならないことは明らかです。 lower_case_with_underscores という命名規則に従う必要があることは明らかです。

私の次のプロジェクトでは、異なる命名規則があるかもしれません。その場合、関連するYAMLファイルでそれを使用します。