C# - Fazendo a revisão do Código fonte : CheckList


Fazer uma última revisão do seu código através de um checklist é uma boa prática que permite otimizar e pegar erros ocultos ou não identificados no processo de testes.

Uma lista de verificação é um hábito saudável que já me salvou de diversos embaraços. Quando você pensa que já esta tudo pronto e testado faça um checklist e você pode se surpreender com os resultados.

Neste artigo eu apresento alguns itens que podem compor a sua lista de verificação do seu código C#.

Fazendo o CheckList

Elimine os alertas do projeto (Project Warnings)

Rode o Code Analysis no projeto para eliminar os alertas

Remova todos as declarações using não utilizadas

Evite referências nulas (null) sem tratamento específico

Use convenções de nomes para variáveis, parâmetros, métodos, classes, etc.

Esteja certo de que o seu código utiliza os princípios SOLID

Garanta a reusabilidade do código

Verifique a consistência do código

Garanta a clareza do código

Verifique se os recursos usados estão sendo liberados

Implemente sempre o tratamento de exceção usando o bloco try/catch/finally

Verifique que os métodos tenham uma única responsabilidades e usem pouco código (no máximo 50 linhas)

Evite laços for/foreach e if aninhados

Realize testes unitários

Utilize StringBuilder ao invés de string para operações de concatenação com strings

Utilize classes sealed , static ou abstract quando pertinente

Utilize interfaces sempre que possível para ter um código desacoplado

Elimine conversões de tipos e conversões forçadas

Verifique a existência de código inalcançável (unreachable code) e corrija

Escreva comentários no cabeçalho de todos os métodos descrevendo o seu uso e os parâmetros usados

Verifique a utilização correta dos modificadores de acesso (private, public, protected, internal, protected internal)

Verifique a utilização correta das palavras chaves: var , object e dynamic

Verifique se seu código esta sujeito injeção SQL

Considere a arquitetura usada na sua aplicação

Utilize constantes e a palavra-chave readonly sempre que possível

Veja os Destaques e novidades do SUPER DVD Visual Basic 2013 (sempre atualizado) : clique e confira !

Quer migrar para o VB .NET ?

Quer aprender C# ??

Mat 6:14 Porque, se perdoardes aos homens as suas ofensas, também vosso Pai celestial vos perdoará a vós;

Mat 6:15 se, porém, não perdoardes aos homens, tampouco vosso Pai perdoará vossas ofensas.

Referências:


José Carlos Macoratti