Clean Code – FORMATAÇÃO

É importante manter uma formatação consistente e fácil de ler no código.

• A importância da formatação: A consistência na formatação é fundamental para evitar confusão e aumentar a compreensão do código, tanto para o programador quanto para quem for ler e manter o código. É importante escolher um estilo de formatação para todo o projeto e garantir que todos os membros da equipe sigam esse estilo.

• Formatação vertical: O código deve ser separado por conceito para que seja mais legível. Devemos separar o código em pequenos blocos lógicos, com um único conceito por bloco; separar esses blocos com linhas em branco para torná-los mais fáceis de identificar visualmente; agrupar linhas de código relacionadas e separar linhas não relacionadas para evitar confusão.
  As funções devem ser organizadas em ordem crescente de abstração, começando pelas funções mais básicas e terminando com as funções mais abstratas e complexas.
  O cabeçalho do arquivo deve ser escrito de forma consistente. Ex.:
  /** * Classe responsável por processar dados de usuários.
* * @author
* Natalia Dartora
* @version
* 1.0
* @since * 25/04/2023
*/

• Formatação horizontal: Embora o alinhamento possa parecer esteticamente agradável, ele pode levar a problemas de manutenção e leitura do código. A legibilidade é mais importante que que a estética do código, alinhamentos em excesso pode tornar o código mais difícil de entender. Devemos utilizar um espaçamento consistente para indentação, geralmente de 4 espaços por nível; evitar o uso excessivo de tabulações; evitar o alinhamento excessivo de variáveis, parâmetros ou valores de retorno de funções, deixando-os alinhados à esquerda e usar 1 espaçamento; utilizar linhas em branco para separar blocos de código relacionados.

• Comentários de formatação: Sobre o comprimento das linhas, devemos evitar mais de 80 caracteres. Embora possa haver exceções, como em alguns casos em que se trabalha com tabelas de dados ou com expressões regulares complexas, é melhor evitar linhas muito longas sempre que possível. Devemos quebrar as linhas de código em várias linhas menores e mais fáceis de ler; dividir expressões longas em várias linhas; usar quebras de linha para separar conceitos diferentes ou agrupar linhas relacionadas; usar comentários com sabedoria para explicar o código quando necessário, em vez de tentar encaixar explicações em uma única linha muito longa; evitar o uso excessivo de parênteses aninhados.

• Outros formatos: Não existe um estilo certo ou errado, mas devemos escolher um estilo de formatação e seguir consistentemente em todo o código. Isso pode incluir o uso de espaçamento e indentação consistentes, a escolha de onde colocar as chaves das declarações de controle de fluxo e a escolha de como lidar com linhas em branco.

A formatação do código é importante não apenas para os desenvolvedores que estão escrevendo o código, mas também para os que o lerão no futuro.