Escrever para ser Revisado

As Melhores práticas 4 - O código deve ser escrito de modo a ser revisado

Ao escrever o código do software, tenha em mente que alguém vai examinar seu código e você terá de enfrentar críticas sobre um ou mais dos seguintes pontos, mas não se limita a:

• Codificação Ruim
• Não seguir padrão
• Não tendo em conta o desempenho
• História, o recuo, os comentários não são adequadas.
• A legibilidade é ruim
• Arquivos abertos não são encerradas
• Memória alocada não tiver sido liberada
• Muitas variáveis globais.
• Muito difícil codificação.
• Mau tratamento de erro.
• Sem modularidade.
• Repetidas do código.

Manter todos os pontos acima referidos em sua mente durante a codificação e parar antes que eles possam saltar em seu código-fonte. Uma vez que você está feito com a sua codificação, vá para a auto-revisão pelo menos uma vez. Tenho certeza que, um auto-exame que ajuda você a remover 90% problemas sozinho.

Uma vez que você está completamente feito com o seu código e auto-revisão, solicitar o seu par para uma revisão do código. Eu recomendaria fortemente a aceitar comentários de revisão devem ser felizes e agradecidos com seu código os comentadores sobre as observações. Mesmo tempo, nunca é bom para criticar qualquer código-fonte escrito por outra pessoa. Se você nunca fez isso, tente fazê-lo uma vez e verificar a expressão da coder.

Aceitar a crítica, mas não criticam

Código fonte mal escritos ensina você a escrever bom código-fonte desde que você tome-o de forma positiva e aprender a lição.

O seu objectivo deve ser para parar os bugs em primeiro lugar e criar um BUG-FREE code. Pense como um testador, de modo que você deve ter um grande desafio para os testadores.