Por que o guia de estilo oficial do Puppet insiste em setas gordas alinhadas? [fechadas]

2

De link :

All of the fat comma arrows (=>) in a resource’s attribute/value list should be aligned. The arrows should be placed one space ahead of the longest attribute name.

Isso parece contraproducente. Tome seu exemplo "ruim":

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

Se você adicionasse um atributo cujo nome fosse maior que "refreshonly", teria que realinhar todas as setas, assim:

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

Todos os atributos desse recurso precisariam ser alterados, para que uma única linha fosse alterada. Isso atrapalha o histórico de revisão e anula o propósito de colocar uma vírgula final no final de uma declaração de atributo / valor (caso contrário, anexar um novo attr / val exigirá que uma vírgula seja anexada à última linha anterior, causando duas linhas para ser alterado em vez de um).

Por que o guia oficial de marionetes recomenda essa convenção?

    
por Sebastian Motraghi 16.10.2013 / 21:16

1 resposta

3

A maioria das convenções de estilo aborda alguns pontos:

  • Melhore a legibilidade.
  • Dissuadir as pessoas de maus hábitos de código.
  • Incentive as pessoas a práticas aceitas há muito tempo (independentemente de quão ruins sejam).

Alinhar as setas de gordura é o ponto de estilo de legibilidade.

    
por 16.10.2013 / 21:26

Tags