Boas práticas de programação em Linguagem C

Por: Eduardo Casavella

INTRODUÇÃO:

A intenção do conjunto de boas práticas apresentadas é escrever código de forma clara e objetiva, facilitando assim as futuras manutenções e extensões do programa.

Embora este artigo tenha sido escrito visando principalmente o programador iniciante em C, todas as práticas podem ser aplicadas a outras linguagens de programação.

BOAS PRÁTICAS

1) Faça sempre um comentário no início do código com as seguintes informações:

  • Nome do programa
  • Objetivo do programa
  • Nome do programador
  • Data de criação

2) Utilize nomes simples e claros para rotinas e variáveis. O tamanho do nome da variável não é importante, mas a clareza sim.
Utilize nomes significativos.

Ao invés de usar:

x = y - z;

é muito mais claro usar:

salario_liquido = salario_bruto - descontos;

Isto não quer dizer que os nomes tem que ser obrigatoriamente longos. Você pode usar tranquilamente i, j, k para índices em vetores ou como contadores de loops desde que fique claro o significado dessas variáveis por convenção.

3) Indente seu código de forma adequada sempre.

4) Antes do corpo do código de cada função faça sempre um comentário explicando o que ela faz.

5) Se a rotina for muito grande é importante explicar também qual é a finalidade de cada variável a fim de facilitar o entendimento e a manutenção.

6) Declare as variáveis logo após o título da rotina. Não declare as variáveis “soltas” no meio do código da função.
Organize seu código, sempre declarando as variáveis logo após o título da rotina e em seguida inicialize-as.

7) Seja sempre claro e objetivo. Não convém usar comandos muito rebuscados só porque você aprendeu uma forma interessante de fazer uma determinada operação, mas que ninguém (ou quase ninguém) usa. Pense que outra pessoa pode ter que dar manutenção no código e ficar confusa com um comando exótico.

8 ) Procure não fazer rotinas excessivamente extensas. Quanto menor e mais objetiva for a rotina, melhor.

9) Evite repetições de código. Caso um trecho de código apareça várias vezes no programa, construa uma rotina e chame-a quando for necessário. Quanto menor for o tamanho da rotina, normalmente é mais fácil para depurar.

10) Faça o planejamento. Tenha sempre qual é seu objetivo em mente. Não saia escrevendo código sem saber direito o que vai fazer. Elabore um diagrama no mínimo. Acredite, isso ajuda muuuito.

11) Evite a utilização de Números Mágicos:
Os chamados números mágicos são valores que aparecem no código e são usados como constantes, embora não tenham sido declarados como tal. Ao invés de usar o número utilize uma constante previamente declarada com #define.

Exemplo:

Ao invés de escrever o código usando os valores como a seguir:

if( consumo < 700 )
{
         tarifa = consumo * 0.90;
}

Seria mais interessante substituir os números por constantes com os nomes adequados:

if( consumo < LIMITE )
{
              tarifa = consumo * FATOR_DESCONTO;
}

12) Utilize o espaçamento de forma a tornar o código mais legível.

Veja o exemplo:

for(i=0;i<=10;i++)
{
//bloco de código
}

Observe como usando espaçamento de forma adequada dentro do for o comando torna-se muito mais legível:

for ( i = 0; i <= 10; i++)
{
//bloco de código
}

13) Declare as constantes no início do código e nunca no meio do mesmo.

14) Utilize sempre letras maiusculas para nomear as constantes em linguagem C.

Exemplo:

#define LIMITE 700
#define FATOR_DESCONTO 0.90

15) Utilize sempre { } mesmo que seja para apenas um comando dentro do bloco.

16) Não exagere nos comentários. Comandos óbvios não precisam ser comentados.
Veja um exemplo:

i++; // incrementando i

Esse é o tipo de comentário completamente desnecessário, pois qualquer programador C sabe o significado do comando.

17) Explique fórmulas complexas e passos complicados de um determinado algoritmo. Nesses casos, um comentário explicativo torna-se obrigatório a fim de que a manutenção do código possa ser feita com menos esforço.

18) Escreva os comentários necessários na medida que for escrevendo o código. Não escreva o código e deixe para comentar depois. É bem mais
fácil elaborar os comentários quando você ainda se lembra dos detalhes.

CONCLUSÃO:

As boas práticas facilitam a clareza e legibilidade, facilitam a manutenção e a depuração do código aumentando a produtividade do programador.

Existem muitas outras práticas e convenções que poderiam ser abordadas, mas teríamos que estender muito o assunto o que foge do objetivo do artigo.

De maneira geral podemos dizer que organização é clareza são os pontos chaves da boa programação.

REFERÊNCIAS:

Best Pratices: IBM, Eletrônica, Eu faço Programas