20240519

Clean code - Formatação

Ser consistente
  • Sempre use o mesmo estilo de formatação no projeto todo
  • Incentive todos os membros da equipe a fazer o mesmo
  • Se alterar um código estrangeiro, procure seguir o estilo do projeto que está atualizando e não o seu.
  • Use sempre as melhores práticas de refatoração para atualizar seu código ao longo do tempo.

Otimize para leitura e não para a escrita
  • A ideia é tornar seu código mais legível, facilitando o entendimento das demais pessoas que possam ler seu código.
  • Os desenvolvedores gastam mais tempo para ler o código do que para escrever.
  • O funcionais também gastam muito tempo para ler o código durante os debugs. 

Não mais do que uma declaração por linha
  • Usar apenas uma declaração por linha.

Condense seu código
  • Evite adicionar MUITOS espaços entre as informações.
  • Mantenha-os bem condensados.

Adicione uma única linha em branco para separar as coisas, mas não mais
  • Apenas uma linha em branco para separar as instruções diferentes. Não utilize várias linhas em branco. Quando alguém for ler seu código perderá mais tempo.
  • Quando for instruções que tenham correlação, não manter linhas em branco.

Não fique obcecado em separar linhas em branco
  • Normalmente, quando as instruções forem bem simples, tente manter uma instrução embaixo da outra.
  • Quando, pelo menos uma das instruções for mais complexa, com parâmetros, por exemplo, dê uma linha de espaço para que fique bem claro a visualização e entendimento do código.

Fechar colchetes no final da linha
  • Outro ponto que deve ser evitado é manter o colchete de fechamento de uma instrução numa linha sozinha. A visualização fica melhor ao colocá-lo no final da linha (no final da instrução).

Mantenha chamadas de parâmetro único em uma única linha
  • Evite quebrar o parâmetro (único) para deixá-lo na próxima linha.

Mantenha os parâmetros por trás da chamada
  • Quando houver dois ou mais parâmetros, coloque o segundo parâmetro embaixo do primeiro parâmetro e assim sucessivamente.

Se você quebrar, indente os parâmetros sob a chamada
  • Sempre mantenha os parâmetros abaixo do método que o chama.
  • Parâmetros múltiplos, utilizar de quebra de linha
  • Alinhar parâmetros

Não alinhe cláusulas de TYPE
  • Ao utilizar o alinhamento, indiretamente, sugere que existe correlação entre as definições.

Não encadeie atribuições
  • Evite utilizar encadeamento de várias atribuições, como por exemplo:
    var1 =  var2 = var3 .
  • Use uma atribuição por linha.