Convenciones de Codificación en Java

Se recomienda una declaraci�n por l�nea ya que mejora los comentarios. En otras palabras:

int level; 	// indentation level
int size; 	// size of table

se prefiere sobre:

int level, size;

No debemos poner diferentes tipos en la misma l�nea. Por ejemplo:

int foo, fooarray[]; //WRONG!
Nota:

Los ejemplos de arriba usan un espacio entre el tipo y el identificador. Otra alternativa aceptable es usar tabs, por ejemplo:

int 		level; 		// indentation level
int 		size; 		// size of table
Object 		currentEntry; 	// currently selected table entry

.�Inicializaci�n

Debemos intentar inicializar las variables locales donde son declaradas. La �nica raz�n para no inicializar una variable donde es declarada es si el valor inicial depende de alg�n c�lculo que tiene que ocurrir antes.

.�Situaci�n

Ponemos las declaraciones s�lo al principio de los bloques. (Un bloque es cualquier c�digo encerrado entre corchetes �{� y �}�.) No debemos esperar a declarar variables hasta que son usadas por primer vez; puede confundir la programador despistado y estorbar la portabilidad del c�digo dentro del �mbito.

void myMethod() {
	int int1 = 0; 		// beginning of method block
	
	if (condition) {
		int int2 = 0; 	// beginning of "if" block
		...
	}
}

La �nica excepci�n a esta regla son los indexados para los bucles, que en Java pueden ser declarados en la sentencia for:

for (int i = 0; i < maxLoops; i++) { ... }

Debemos evitar las declaraciones locales que oculten las declaraciones de nivel superior. Por ejemplo, no debemos declarar el mismo nombre de variable en un bloque interno:

int count;
...
	myMethod() {
	if (condition) {
		int count; // AVOID!
	...
	}
...
}

.�Declaraciones de Clases e Interfaces

Cuando codificamos clases e interfaces Java, se deben seguir las siguientes reglas de formateo:

  • No debe haber ning�n espacio entre el nombre y el par�ntesis �(� que inicia la lista de par�metros.
  • El corchete abierto �{� aparece en la misma l�nea que la declaraci�n.
  • El corchete cerrado �}� empieza una l�nea por s� mismo, identado a su correspondiente sentencia de apertura, excepto cuando es una sentencia null en la que el �}� deber�a aparecer inmediatamente despu�s del �{�:
    class Sample extends Object {
    	int ivar1;
    	int ivar2;
    	
    	Sample(int i, int j) {
    		ivar1 = i;
    		ivar2 = j;
    	}
    	
    	int emptyMethod() {}
    	...
    }
    
  • Los m�todos est�n separados por una l�nea en blanco.

COMPARTE ESTE ARTÍCULO

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