Quando estamos começando a lidar com linguagens de programação, ficamos mais preocupados em fazer nosso código funcionar do que qualquer outra coisa. Normalmente, a última coisa que prestamos atenção é se o código está legível e “bonito” se de ver… Porém, é importante começarmos a seguir algumas boas práticas de codificação desde o início. Isso irá lhe auxiliar a criar o hábito de escrever código de fácil entendimento e de manutenibilidade aprimorada. Às vezes, nós mesmos não conseguimos entender um código que fizemos a um tempo atrás. Se você está iniciando agora, veja algumas dicas para colocar em prática.
Curso
Java - Fundamentos
Conhecer o curso
Utilize nomes significativos
Quando escrevemos qualquer trecho de código que seja, é importante deixar claro o que é uma variável ou o que um método faz. Um dos pontos que precisamos seguir para atingirmos este objetivo é utilizarmos nomes significativos para as nossas estruturas de código. Evite nomear variáveis, métodos e classes com nomes que não tenham nada a ver com o contexto… O código deve ser simples e direto, deixando claro a sua intenção logo na primeira leitura. Por exemplo: quando estamos iniciando nossos estudos em desenvolvimento e precisamos escrever uma estrutura de código que faça uma soma, geralmente escrevemos algo similar ao abaixo:
public int fazer_a_soma(int a, int b)
{
return a + b;
}
Veja que temos alguns pontos que poderíamos melhorar, tornando nosso código mais legível: poderíamos simplificar o nome do método e darmos nomes mais claros para os nossos parâmetros… Nosso método, depois de corrigido (ou refatorado), poderia ficar da seguinte maneira:
public int somar(int numero1, int numero2)
{
return numero1 + numero2;
}
Cuidado com os comentários!
Os comentários geralmente nos ajudam a explicar ou recordar de algo no código. Porém, comentários em excesso não é algo muito legal… Se você está tendo que explicar tudo que ocorre em seu código, é porque o código provavelmente está mal escrito ou bagunçado. Sendo assim, tente sempre restringir os comentários aos trechos onde realmente seja necessário. Trechos de código que sigam práticas como a utilização de nomes significativos geralmente auxiliam a restringir os comentários aos trechos onde os mesmos sejam de fato necessários.
Reaproveite o código
Se você está fazendo algo que já existe em mais de um lugar, é interessante pensar em uma forma de evitar essa duplicidade. Por isso, sempre pense em reaproveitamento de código, criando estruturas (como classes e métodos) mais abstratas e reaproveitáveis. Pensar em reaproveitamento de estruturas diminui o volume de código e torna o processo de manutenção centralizado e muito mais facilitado.
Idente seu código
A identação, que consiste nos tabs ou espaços agrupando os diferentes blocos de código, é algo essencial. Um trecho de código mal identado é terrivelmente difícil de ser lido. Por isso, atente-se sempre à identação dos trechos de código que você escrever. Lembre-se também que a maioria das IDEs e editores de texto modernos possuem atalhos que identam todo seu código de maneira rápida e automática, portanto: utilize este recurso sempre! Veja abaixo um trecho de código com identação incorreta. Repare que o código é super complicado de ser lido, ainda mais por se tratar de um trecho de código com múltiplos blocos.
if(idade > 18) {
System.out.println("Idade maior que 18");
} else if(idade == 18) {
System.out.println("Idade é igual a 18");
} else {
System.out.println("Idade menor que 18");}
Veja agora o mesmo trecho de código corretamente identado. Veja que o código parece mais “fluído”, se tornando muito mais fácil de ser lido simplesmente por estar com a identação correta.
if(idade > 18) {
System.out.println("Idade maior que 18");
} else if(idade == 18) {
System.out.println("Idade é igual a 18");
} else {
System.out.println("Idade menor que 18");
}
Mesmo sendo iniciante, é importante sempre estarmos atentos às possibilidades de como melhorar nosso código, pois isso é um ponto que o mercado em geral valoriza muito. Por mais que a maioria das empresas desejarem que seus softwares funcionem, elas também esperam que o código produzido apresente qualidade. Bons desenvolvedores estão atentos hoje às boas práticas de codificação. Neste artigo, foram abordadas algumas práticas mais simples. Mas, caso queira se aprofundar ainda mais em pontos relacionados às boas práticas de código limpo, temos o artigo “Dicas para manter seu código limpo e legível” para que você possa melhorar cada vez mais a escrita de seus códigos.
