Convenciones de Codificación en Java

No debemos hacer p�blicas ninguna variable de ejemplar o de clase sin una buena raz�n. Frecuentemente las variables de ejemplar no necesitan configurarse expl�citamente - porque normalmente esto sucede como un efecto lateral de llamadas a m�todos.

Un ejemplo de variables de ejemplar p�blicas apropiadas es el cadso donde la clase esencialmente es una estructura de datos, sin comportamiento. En otras palabras, si tuvieramos una estructura en lugar de una clase (si Java soportara estructuras), entonces seri� apropiado hacer p�blicas las variables de ejemplar.

.�Referenciar Variables de Clase y M�todos

Debemos evitar usar un objeto para acceder a variables de ejemplar (est�ticas) o m�todos. En su lugar debemos usar la clase. Por ejemplo:

classMethod(); //OK
AClass.classMethod(); //OK
anObject.classMethod(); //AVOID!

.�Constantes

Las constantes num�ricas (literales) no deber�an codificarse directamente, excepto -1, 0, y 1, que pueden aparecer en un bucle for como valores de contador.

.�Asignaciones de Variables

Debemos evitar asignar varias variables al mismo valor en una s�la sentencia. Es d�ficil de leer, por ejemplo:

fooBar.fChar = barFoo.lchar = 'c'; // AVOID!

No debemos usar el operador de asignaci�n en lugares donde pueda ser f�cilmente confundible con el operador de igualdad, por ejemplo:

if (c++ = d++) { // AVOID! (Java disallows)
	...
}

Deber�a escribirse como:

if ((c++ = d++) != 0) {
	...
}

No debemos usar asignaciones embebidas en un intento de mejorar el rendimiento de ejecuci�n. Ese es el trabajo del compilador. Por ejemplo:

d = (a = b + c) + r; // AVOID!

Deber�a escribirse como:

a = b + c;
d = a + r;

.�Pr�cticas Miscel�neas

.�Par�ntesis

Generalmente es una buena idea usar par�ntesis para liberar expresiones que incluyen m�zclas de operadores para evitar problemas de precedencia de operadores. Incluso si la precedencia del operador parece clara para nosotros podr�a no ser as� para otros -- no deber�amos asumir que otros programadores conecen la precedencia tan bi�n como nosotros.

if (a == b && c == d) // AVOID!
if ((a == b) && (c == d)) // USE

.�Valores de Retorno

Debemos intentar hacer que la estructura de nuestro programa corresponda con nuesta intenci�n. Por ejemplo:

if ( booleanExpression) {
	return true;
} else {
	return false;
}

deber�a escribirse como:

return booleanExpression;

De forma similar,

if (condition) {
	return x;
}
	return y;

deber�a escribirse como:

return (condition ? x : y);

.�Expresiones antes del �?� en el Operador Condicional

Si una expresi�n que contiene un operador binario aparece antes del '?' en el operador terciario ?:, deber�a ponerse entre par�ntesis, por ejemplo:

(x >= 0) ? x : -x;

.�Comentarios Especiales

Debemos usar XXX en un comentario para marcar algo que es fraudulenteo pero funciona; y FIXME para marcar algo que es fraudulento y no funciona.

COMPARTE ESTE ARTÍCULO

COMPARTIR EN FACEBOOK
COMPARTIR EN TWITTER
COMPARTIR EN LINKEDIN
COMPARTIR EN WHATSAPP
SIGUIENTE ARTÍCULO