40 Boas Práticas de Programação

Um bom código deve ser limpo, claro e direto!

Quando comecei a cursar Sistemas de Informação, meu então professor Aluisio Eustáquio da Silva nos passou uma lista com 40 boas práticas de programação em C#. Se você está começando sua carreira agora, não deixe de dar uma olhada!

Boas Práticas de Programação

  1. Escreva os programas de maneira bem simples e direta (sem complicar)
  2. Leia documentos a respeito da versão  da Linguagem C# que estiver usando
  3. Faça pequenos programas para testar os comandos da linguagem
  4. Leia e estude cada mensagem de erro emitida pelo compilador
  5. Comece todo programa com um comentário descrevendo a finalidade do mesmo
  6. Coloque nas funções, que imprimem alguma mensagem, como último caractere de impressão, um comando de fim de linha (n ou WriteLine)
  7. Termine toda função com return
  8. Recue o corpo de uma função (endentação), fazendo com que a mesma fique mais legível
  9. Estabeleça um critério de espaços nos recuos (Padrão C#:  4 espaços)
  10. Declare cada variável em uma linha para facilitar a escrita de comentários
  11. Coloque um espaço após cada vírgula (ou ponto e vírgula)  na estrutura for
  12. Escolha nomes significativos para as variáveis
  13. Comece o nome dos identificadores com letra MAIÚSCULA, e, da mesma forma, cada palavra das variáveis com nomes compostos
  14. Declare as variáveis sempre no início das funções
  15. Coloque sempre uma linha em branco entre a declaração de variáveis e os comandos seguintes
  16. Coloque espaços dos dois lados dos operadores aritméticos
  17. Escreva parênteses, ainda que redundantes, para facilitar o entendimento de expressões aritméticas
  18. Quebre um comando longo em comandos menores e mais simples
  19. Faça endentação no corpo de uma estrutura
  20. Escreva um comando por linha
  21. Separe os comandos longos em várias linhas, quebrando-as em pontos que façam sentido
  22. Consulte as tabelas de precedência dos operadores aritméticos e, em caso de dúvida,  escreva parênteses para efetuar as operações da forma pretendida
  23. Use um “pseudocódigo” para “bolar” um programa
  24. Endente o corpo do comando if e else
  25. Endente todos os níveis com o mesmo espaçamento
  26. Escreva sempre chaves nos comandos de controle (if/else, while, for etc.), mesmo que não seja obrigatório
  27.  Digite as chaves, parênteses e  colchetes (abrindo e fechando) antes de digitar os comando ou expressões entre eles
  28. Inicialize contadores, somatórios ou produtórios
  29. Imprima mensagens de erro em expressões que tenham restrições de valores, tais como divisão por zero, raiz quadrada de número negativo, entrada de dados inválidas, dentre outras
  30. Solicite ao usuário os valores a serem digitados, com mensagens adequadas
  31. Explicite os valores dos “flags” nas entradas de dados que os contêm
  32. Use o valor absoluto da diferença entre dois números reais, menor que um valor pequeno,  em vez de  comparar números reais com sinal de igualdade ou desigualdade
  33. “Inicialize” as variáveis ao declará-las, sempre que possível
  34. Escreva os operadores unários sempre próximos das variáveis (sem espaços)
  35. Controle as repetições com  valores inteiros
  36. Evite muitos níveis de endentação, pois estes tornam os programas difíceis de serem entendidos
  37. Use <= ou >= em lugar de < ou >, nas estruturas de repetição, para evitar executar uma iteração a menos
  38. Evite alterar as variáveis de controle do laço for, dentro do corpo do laço
  39. Coloque sempre o default no comando switch para chamar a atenção em casos excepcionais
  40. Teste os programas exaustivamente!

// Comente!

comentários

eufacoprogramas

Olá, eu sou a Gabi e eu criei o "Eu Faço Programas" em 2011, quando ainda trabalhava em desenvolvimento web. Atualmente meu trabalho é focado em estratégia digital e redes sociais. Quer saber mais? www.imgabi.com

6 Comentários

  • Responder setembro 13, 2011

    Marcio Paim

    Muito boas essas dicas para quem está começando e ainda está meio perdido.
    Aproveito para compartilhar um guia que encontrei há um bom tempo atrás na net. Embora ele seja mais específico que os conselhos acima, acho que vale muito dar uma lida. Segue o link: http://www.koonsolo.com/news/dewitters-tao-of-coding/

  • Responder setembro 25, 2011

    Marcos

    Muito legal essas dicas,vai para os favoritos.

  • Responder outubro 5, 2011

    rasherx

    Aluisio foi meu professor também. Eu estudei Sistemas de Informação na PUC Minas, de Betim. Terminei meu curso em dezembro de 2009.

    • Responder outubro 5, 2011

      admin_pr

      Ele é ótimo, não é?

  • […] Pratices: IBM, Eletrônica, Eu faço Programas Publicado em Sem categoria por oibezao. Marque Link […]

  • Responder setembro 6, 2014

    Diego Motta

    Parabéns pelo blog.
    Grande dica.
    Sou programador iniciante e estudante pelo curso adv, http://www.cursoadv.com.br
    Adorei o site, continue o bom trabalho.

// Siga as boas práticas: Comente!