Continuando nossa saga de transformar vocês, jovens padawans, em mestres super sayajins (NullPointerException) da codificação maneira, vamos a mais algumas pérolas de sabedoria…

07. Use padrões de nomenclatura de métodos e variáveis (code conventions)

Sempre que uma variável ou uma função é criada, seu nome deve ser descritivo o suficiente para dar uma ideia geral do que ele faz ou para que será usado.

Existe empresas que têm seus próprios padrões de nomenclatura (ex. use o prefixo “int” para qualquer das variáveis numéricas), mas também existem muitas empresas em que os empregados não têm compromisso de manter esses padrões. A preguiça faz com que as pessoas trabalhem o dobro do tempo durante um possível refatoramento no futuro. Quem já pegou algum código maluco para dar manutenção sabe do que estamos falando.

08. Escreva nomes de métodos/variáveis/classes que façam sentido

Nada mais irritante que pegar um código onde tenha um método do tipo “busca(String s)”… qual é o formato do maldito parâmetro que devo passar para o método? Nesses casos, aconselho a escrever algo do tipo buscaUsuarioPorNome(String nome).

Ou, então, imagine procurar entender para que serve a variável com o nome “x” e “y”? Se você não estiver codificando algo que envolva o plano cartesiano, por favor, utilize nomes de variáveis inteligíveis, com CamelCase. Ex.: Usuario usuarioSelecionado.

Não fique com preguiça de dar nomes bacanas para esses elementos do código, porque mais pra frente você (e a equipe que desenvolve com você) vai se confundir pra valer para entender e lembrar a lógica do seu sistema. Fazendo isso, você ainda ganha de brinde uma necessidade menor de documentar seu código (será que precisa comentar um método como ArrayList listaProdutosPorIdFornecedor(String idFornecedor) ?).

09. Aprenda a usar o “this.”

Quando você programa um método, principalmente com muitas variáveis, acaba ficando confuso quais variáveis são “descartáveis” e quais são realmente importantes para o objeto. Para ajudar um pouco na compreensão do código, recomendo fortemente utilizar o this. Com ele, você não deixa dúvidas de qual variável você está tratando.

10. Trate as alterações com cuidado

Para fazer alterações sem bagunçar o código já existente, é necessário sempre se atentar às dicas já citadas. Sempre que há uma necessidade de adicionar, remover ou alterar alguma coisa no código, também deve haver uma consciência de não interferir (e bagunçar) com o código original, mantendo o código limpo e ordenado.

Isso envolve principalmente:

• Manter a identação correta (por exemplo, ao inserir uma cláusula IF, todo o conteúdo deverá ser identado para dentro do if).

• Comentando sobre a modificação feita ou adicione a descrição da modificação aos comentários existentes.

• Respeitar o code conventions.

11. Evite misturar linguagens indiscriminadamente na página

CSS inline e métodos JavaScript espalhados dentro de tags html são bons exemplos de como NÃO misturar essas linguagens! Ignorar esse princípio vai resultar em tags inchadas com uma propriedade de estilo incorporada, javascript sem sentido, e é claro e muita confusão.

Mesmo com a adição de comentários, ele ainda vai parecer com tudo e nada ao mesmo tempo. Tendo a divisão adequada entre diferentes linguagens, dará uma certa ordem na lógica da sua página.

O melhor a ser feito é utilizar corretamente o atributo class e id das tags para que você possa adicionar funcionalidades (javascript) e estilo (css) de forma não intrusiva. E pra te ajudar ainda mais a selecionar e a encontrar os elementos que você quer dar dinamismo, recomendo fortemente usar o pouco conhecido JQuery. =)

12. Resuma as importações da página

Mesmo que seja muito melhor ter mais linguagens de codificação importadas de arquivos diferentes, isso deve ser usado com parcimônia. Se houver muitas folhas de estilo (css), você provavelmente pode agrupá-las em um ou dois arquivos.

Isso não só irá poupar espaço na codificação (sem um zilhão de imports) e fazer seus códigos parecerem mais limpos, também irá poupar tempo de carregamento. Cada arquivo importado é uma solicitação HTTP que mexe com o desempenho da sua página. Assim, além de ser uma consideração para arrumação, é também uma consideração para a eficiência.

Compilando

Bom, é claro que dá pra elencar mais um monte de dicas de boas práticas para programadores (ex.: nunca programe bêbado; convença seu chefe de aquele bug é uma feature; se compilou, valeu; etc.), mas essas são algumas regras de ouro que podem ser usadas no seu dia-a-dia como programador e diminuir o risco de seus colegas de trabalho (e de subversion/cvs) riscarem seu carro no estacionamento por conta de um programa mal feito.

E se você acha que tem alguma boa dica para dar aos nossos estimados leitores, não guarde para si, compartilhe nos comentários.

Até a próxima!

Algumas referências sobre code conventions:

• http://www.oracle.com/technetwork/java/codeconvtoc-136057.html

• http://en.wikipedia.org/wiki/Coding_conventions