Introdução
O principal objetivo deste post é disponibilizar algumas dicas simples algumas maneiras simples de como encontrar erros e dar manutenção de maneira mais simples em um código fonte.
Dicas
1º Escreva um código auto explicativo.
Tente escrever um código auto explicativo, que por si só diga o que faz passo a passo, por exemplo caso você tenha uma variável que guarde um atributo do tipo texto o valor de um nome do usuário, de um nome para ela de "nome" ou "nomeUsuario" não faz sentido colocar o nome dessa variavel de "n" ou algo parecido.
Tente dar nomes aos métodos de sua classe que faça sentido, caso seu método seja um gerador de organizador de texto por exemplo, de um nome para o mesmo que se condiz com sua função, por exemplo "organizar Texto".
2º Escreva métodos pequenos
Escreva métodos pequenos de no máximo 25 linhas, isso tornará seu código mais fácil de manutenção.
3º Reaproveite o código
Reaproveite os métodos e trechos e códigos já criados na mesma classe, evite colocar trechos de códigos repetidos que faça a mesma função em toda um classe. Um exemplo seria ter uma condição que verifica se uma variável está nula, crie um método que faça isso e o chame quando necessário, isso evitará manutenção em várias locais para o mesmo fim.
4º O modo debug é seu amigo
Quando possível debug seu código isso poderá facilitar em muito o processo para achar os erros mais facilmente.
5º Não esconda exceções para baixo do tapete
Em nenhuma hipótese capture um exceção e faça ela desaparecer. Caso o seu código capture uma execeção exiba de alguma maneira que a mesma foi capturada.