Guia de estilos
Um padrão ou estilo de código é um conjunto consistente, porém flexível, de "práticas recomendadas" projetado para melhorar a qualidade e a legibilidade e, ao mesmo tempo, facilitar as alterações e a manutenção do código. Ele
- abrange todos os aspectos da construção do código
- é projetado para melhorar a adaptação e a manutenção
- não forma um conjunto inflexível de padrões
- é consistente
- não é "tamanho único"
- define "práticas recomendadas" para escrever códigos
- deve se adaptar às mudanças
Um padrão de código é um conjunto de convenções (às vezes arbitrárias) sobre como escrever código em um projeto. É muito mais fácil entender uma grande base de código quando todo o código nela contido está em um estilo consistente.
Ao garantir um estilo de código em seu projeto, você obterá os seguintes benefícios: legibilidade, estrutura do programa, práticas de programação, correção, portabilidade/interoperabilidade, reutilização, desempenho e globalização/localização.
Se não tiver certeza de onde ou como começar, há muito trabalho na comunidade em torno de padrões para as linguagens mais comuns, confira aqui e aqui, escolha um e siga-o.
Quando você e sua equipe estiverem de acordo com a prática, não se esqueça de aplicar seu padrão de código diariamente. Você pode configurar seu IDE para verificar automaticamente se há código fora do padrão, instalar complementos e extensões, conectar ferramentas externas em seu processo CI/CD e até mesmo verificá-lo em seu processo de revisão de código.
Créditos