☰

为什么官方的 Puppet 风格指南坚持使用对齐的粗箭头？

tag-icon • tag-icon puppet
为什么官方的 Puppet 风格指南坚持使用对齐的粗箭头？

从http://docs.puppetlabs.com/guides/style_guide.html：

资源的属性/值列表中的所有粗逗号箭头 ( =>) 都应对齐。箭头应放在最长属性名称前一个空格处。

这似乎适得其反。以他们的“坏”例子为例：

exec { 'test':
  subscribe   => File['/etc/test'],
  refreshonly => true,
}

如果添加的属性名称比“refreshonly”更长，则必须重新调整所有箭头，如下所示：

exec { 'test':
  subscribe       => File['/etc/test'],
  refreshonly     => true,
  somenewproperty => whatever,
}

为了更改一行，该资源中的每个属性都需要更改。这会混淆修订历史记录，并且违背了在属性/值声明末尾添加尾随逗号的目的（否则，附加新的 attr/val 将需要在之前的最后一行附加逗号，从而导致更改两行而不是一行）。

为什么官方 Puppet 风格指南推荐这种惯例？

答案1

大多数样式约定都涉及以下几点：

  • 提高可读性。
  • 劝阻人们养成不良的代码习惯。
  • 敦促人们采取长期接受的做法（无论这些做法有多糟糕）。

对齐粗箭头是可读性样式点。

相关内容