Boas Práticas de Programação

[JoezerSmaniotto]

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.

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.

[JoezerSmaniotto]

Issue aberta, apenas para aplicar desafio, do projeto desenvolvido na semana 3 do Ignite da rocketseat.

[JoezerSmaniotto]

Good