Implementación de convenios de codificación en Java

RECU-0734 (Recurso Ejemplo)

Descripción

Se muestran ejemplos que siguen los convenios de codificación en Java.

Ejemplos

Nomenclatura de métodos

Ejemplos de este tipo de nomenclatura pueden ser:

agregarPermiso();
getCodigoPostal();

Nomenclatura de parámetros y variables

Ejemplos de este tipo de nomenclatura pueden ser:

permiso;
codigoPostal;

Nomenclatura de constantes

Un ejemplo de la nomenclatura para las constantes puede ser:

static final int LONGITUD_MAXIMA = 999;

Uso de espacios en blanco

A continuación se muestran ejemplos sobre el uso de los espacios en blanco

// Para separar una palabra clave y la apertura de un paréntesis
// Para separar una palabra clave, o un cierre de paréntesis, y una apertura de llaves
if (a == 100) {
  ...
}
else {
  ...
}
// Tras las comas en una lista
int [] lista = {1, 2, 3};
// Tras los punto y comas de una sentencia for
for (int i=1; i<10; i++) {
   ...
}

Ubicación de llaves {}

static public int SumaMatriz(int[] matriz) {
   int suma = 0;
   for(int i = 0; i < matriz.length; i++) {
      suma += matriz[i];
   }
   return suma;
}

Construcción de código autodocumentado

Los siguientes ejemplos muestran cómo crear código autodocumentado

// Código mal escrito:

for ( i = 2; i <= num; i++ ) {
   meetsCriteria[ i ] = true;
}

for ( i = 2; i <= num / 2; i++ ) {
    j = i + i;
    while ( j <= num ) {
       meetsCriteria[ j ] = false;
       j = j + i;
    }
}

for ( i = 1; i <= num; i++ ) {
     if ( meetsCriteria[ i ] ) {
        System.out.println ( i + " meets criteria." );
     }
}

// Código bien escrito:

for ( primeCandidate = 2; primeCandidate <= num; primeCandidate++ ) {
   isPrime[ primeCandidate ] = true;
}

for ( int factor = 2; factor < ( num / 2 ); factor++ ) {
    int factorableNumber = factor + factor;
    while ( factorableNumber <= num ) {
        isPrime[ factorableNumber ] = false;
        factorableNumber = factorableNumber + factor;
    }
}

for ( primeCandidate = 1; primeCandidate <= num; primeCandidate++ ) {
   if ( isPrime[ primeCandidate ] ) {
      System.out.println( primeCandidate + " is prime." );
   }
}