Regras de codifica��o para os sistemas da PRD

ADS.FAQ-18373

Este artigo estabelece o padr�o de codifica��o dos sistemas desenvolvidos pela PRD. Este padr�o deve ser sempre utilizado a n�o ser que o desenvolvimento seja um projeto para um cliente que exige um padr�o diferente.

Objetivo

As regra de codifica��o existem para dar manutenibilidade do c�digo. Para tal, precisamos que ele tenha as seguintes caracter�sticas:

Legibilidade: Qualquer codifica��o DEVE deixar claro o que est� sendo feito.
Simplicidade: O c�digo DEVE ser o mais simples poss�vel. Quando a tarefa n�o for simples, a complexidade deve ser desmembrada em partes, geralmente formada por m�todos que possuam um nome significativamente claro.

Regras gerais

Utilizar nomes de vari�veis que indiquem claramente o seu significado. N�o utilizar v�ri�veis como nomes tipo "tmp". Vari�veis tipo "i", "x", "j", podem ser utilizadas somente como contadores dentro de blocos de repeti��o para iterar nos elementos de um array, por exemplo.
Declarar vari�veis locais o mais pr�ximo de seu uso poss�vel.
Onde poss�vel, testar condi��es e valida��es na ordem inversa de seu custo, ou seja, quando houver um teste que pode evitar o outro teste, fa�a primeiro o teste que requer menos processamento.
Quando a l�gica permitir, evite o n�mero de condi��es aninhadas em v�rios n�veis.
Um m�todo deve fazer um �nica tarefa.

Um �nico ponto de sa�da

Sempre que poss�vel, deve-se evitar que uma rotina tenha v�rios "return". Este tipo de pr�tica desestrutura o c�digo e deve ser evitado. Procure fazer com que os m�todos tenham um �nico ponto de sa�da.

Coment�rios no c�digo

Um c�digo muito bem feito praticamente n�o precisa de coment�rios. Jamais devem ser inclu�dos coment�rios para coisas �bvias. Coment�rios desnecess�rios apenas poluem o c�digo e devem ser evitados. Coment�rios devem ser utilizados apenas para coisas que n�o est�o claras no c�digo ou para justificar alguma a��o.

"if" com c�digo s� no "else"

O c�digo abaixo n�o dever ser realizado:

if (condicao) {
    // nao faz nada
} else {
    ...
}

Parenteses obsoletos

Evitar coisas tipo:

if ((x == y)) {
...

Operador tern�rio

Se for necess�rio indentar um operador tern�rio, deve-se fazer da seguinte forma:

String msg = x > y
    ? "Xiz"
    : "Ipslon";

Deve-se evitar encadear operadores tern�rios. A �nica exce��o seria uma rela��o de condi��o->valor:

       System.out.println(
               x > 3 ? "Maior que tres":
               x > 2 ? "Maior que dois":
               x > 1 ? "Maior que um":
               "Igual ou menor que 1");