Siga os padrões
Melhor prática 3 - Siga os padrões definidos, não os crie
A maioria das organizações de software padrão mantém seus padrões de codificação. Esses padrões teriam sido estabelecidos por desenvolvedores de software bem experientes após passar anos com o desenvolvimento de software. Isso é equivalente a seguir os passos de grandes pessoas deixadas para trás.
Se sua organização não possui nenhum padrão, então eu sugiro pesquisar na internet por padrões de codificação de diferentes linguagens de programação e você encontrará muitos. Um padrão de codificação fixaria as regras sobre vários atributos importantes do código, poucos estão listados abaixo:
- Convenção de nomenclatura de arquivos
- Convenção de nomenclatura de funções e módulos
- Convenção de nomenclatura de variável
- História, recuo, comentários
- Diretrizes de legibilidade
- Lista do que fazer e não fazer
Mas uma vez definido, comece seguindo o padrão definido em vez de criá-lo ou alterá-lo todos os dias. Eu definitivamente diria:
O código fonte é o seu BEBÊ!
Portanto, mantenha-o limpo, consistente e bonito. Quando digo bonito, realmente significa bonito. Se seu código for bonito, será fácil para outras pessoas lerem e entenderem. Se você continuar mudando as regras de codificação todos os dias, depois de alguns dias, você mesmo não será capaz de ler e entender o código escrito por você.