什么是规范的YAML命名风格

时间:2014-03-31 20:09:53

标签: yaml

我正在设计一个新的YAML文件,我想使用最标准的命名方式。这是什么?

联用?

- job-name:
    ...

lower_case_with_underscores?

- job_name:
    ...

驼峰?

- jobName:
    ...

2 个答案:

答案 0 :(得分:42)

使用周围软件规定的标准。

例如,在我当前的项目中,YAML文件包含Python属性的默认值。由于YAML中使用的名称出现在关联的Python API中,因此很明显,在此特定项目中,YAML名称应遵循每个PEP-8的Python tickparams命名约定。

我的下一个项目可能有不同的主流命名约定,在这种情况下,我将在相关的YAML文件中使用它。

答案 1 :(得分:25)

添加到@ john的答案:

使用CamelCase的Kubernetes:https://kubernetes.io/docs/user-guide/jobs/

protected override async Task OnActivateAsync() { ActorEventSource.Current.ActorMessage(this, "Actor activated."); var initialized = await this.StateManager.ContainsStateAsync("initalized"); if (!initialized) await Initialize(); } private async Task Initialize() { ActorEventSource.Current.ActorMessage(this, "Actor initialized."); await this.StateManager.AddStateAsync("initialized", true); } apiVersion

CircleCI使用snake_case:https://circleci.com/docs/1.0/configuration/

restartPolicy minitest_globsvcs_url

Jenkins with dash-case:https://github.com/jenkinsci/yaml-project-plugin/blob/master/samples/google-cloud-storage/.jenkins.yaml

build_url

所以看起来没有一个明确的标准,项目使用他们自己的惯例。