Convención de formato de código en lenguaje Java

LIBP-0016 (Libro de pautas)

Aplicar un buen formato a la codificación mejora su legibilidad y facilita su mantenimiento.

Algunas de las directrices marcadas para el formato del código pueden estar automatizadas a través de la herramienta utilizada para el desarrollo, por lo que pueden “pasar a un segundo plano” durante la construcción del componente.

Pautas

TítuloCarácter
Líneas en blancoObligatoria
Espacio en blancoObligatoria
Alineación y sangríaObligatoria
Ubicación de llaves “{ }”Obligatoria
Expresiones largasObligatoria

Líneas en blanco

Se utilizarán líneas en blanco para agrupar secciones de código que estén lógicamente relacionadas.

Además se deberán utilizar líneas en blanco en los siguientes casos:

  • Para separar los comentarios de cabecera del fichero, sentencia package y sentencias import.
  • Entre declaraciones de clases.
  • Entre declaraciones de métodos.
  • En una clase, entre la última variable y el primer método.

Espacio en blanco

Se utilizará un espacio en blanco en los siguientes casos:

  • Para separar una palabra clave y su paréntesis asociado. Se aplica a las siguientes palabras clave: catch, for, if, switch, synchronized, while.
  • Para separar una palabra clave que lleva un argumento, por ejemplo: return true;
  • Entre dos palabras clave.
  • Entre una palabra clave o un paréntesis de cierre y una apertura de llaves “{“
  • Tras una coma en una lista
  • Tras un punto y coma en una sentencia for: for (expr1; expr2; expr3) {

No se utilizará un espacio en blanco en las siguientes situaciones:

  • Entre el nombre de un método y la apertura de paréntesis
  • Después de una apertura de paréntesis o antes de un cierre de paréntesis.
  • Después de una apertura de corchetes o antes de un cierre de corchetes.

Alineación y sangría

Se establece una tabulación de tres caracteres. Estos han de ser espacios en blanco y no el carácter de tabulador.

Ubicación de llaves “{ }”

Los bloques de código englobados entre llaves seguirán las siguientes reglas:

  • La llave de apertura irá ubicada al final de la primera línea.
  • La llave de cierre irá sola en una línea, alineada con la misma columna que la primera línea del bloque de código.
  • Todas las sentencias de tipo if, while, for while o ifElse tendrán una llave de apertura y una de cierre
  • Las sentencias entre las llaves tendrán un nivel más de sangría que las llaves.

Ejemplo:

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

Expresiones largas

Si una expresión es excesivamente larga se ha de cortar en diferentes líneas.

Se seguirán las siguientes reglas generales:

  • Se dividirá la línea después de un coma
  • Se dividirá la línea antes de un operador

La principal regla general a seguir es que el corte se realizará de tal forma que no se pierda la legibilidad.