Guía estilo java

M etodología y Tecnología de la Programación

GUÍA DE ESTILO EN JAVA
Formato de líneas 1. No usar más de 80 caracteres por línea (imagen de tarjeta). De esta forma se pueden visualizar las líneas completas con un editor de texto o en una hoja impresa tamaño DIN A4. Cuando la línea sea mayor de 80 caracteres, divídala en varias partes, cada una sobre una línea. Salte de línea al final de unacoma o al final de un operador. Si se trata de una expresión con paréntesis salte, si es posible, a línea nueva después de finalizar el paréntesis. Por ejemplo, casos válidos serían, public void metodoHaceAlgo(int valor1, double valor2, int valor3){ resultado = aux* (final-inicial+desplazamiento) + referencia; 3. Use líneas en blanco como elemento de separación entre bloques de códigoconceptualmente diferentes. Sangre adecuadamente cada nuevo bloque de sentencias. Entre dos y cuatro espacios en blanco son suficientes para cada nivel de sangrado. De esta forma se aprecia visualmente la diferencia de nivel entre bloques de sentencias, sin rebasar, normalmente, los 80 caracteres por línea. A la hora de sangrar, y para evitar problemas de compatibilidad entre editores de texto, use espacios yno tabuladores. Por ejemplo, public double calcularDescuento (double total) { int aux=0; // Se sangra dos espacios // Se sangra otros dos espacios

2.

4.

if (total>LIMITE) { total = total * 0.9; } return total; } Ficheros 1. 2. 3. 4.

Incluya una sola clase o interfaz por fichero, o al menos una sola clase o interfaz pública. Si hay comentarios globales para los contenidos del ficherocolóquelos en primer lugar. Si la clase forma parte de un paquete, la sentencia package deber ser la primera del fichero. Si se importan paquetes, la sentencia import debe aparecer después de la sentencia package.

Escuela Superior de Informática-UCLM

1

M etodología y Tecnología de la Programación

5.

Coloque la declaración de las clases o interfaces a continuación de la sentenciapackage.

Clases 1. 2. Coloque en primer lugar los comentarios sobre la clase (vea el apartado comentarios). Coloque los atributos (datos) a continuación. Coloque primero las variables estáticas y a continuación las variables de ejemplar en el orden: público (se recomienda no incluir variables públicas), protegidas y privadas, es decir, public, protected y private en Java. A continuación se declaranlos métodos, con los constructores en primer lugar. El resto de métodos se colocará en orden de interrelación y no por visibilidad. Así, si un método público usa dos métodos privados, se debería colocar primero el público seguido de los dos privados. La idea es que al leer el código se siga con facilidad la funcionalidad de los métodos. Las recomendaciones de los dos últimos puntos se resumirían dela forma siguiente, class NombreClase { variables estáticas variables de ejemplar públicas (debe evitarse su uso) variables de ejemplar protegidas variables de ejemplar privadas métodos constructores resto de métodos }

3.

4.

No deje espacio en blanco entre el identificador del método y los paréntesis, es decir, escriba,

public void nombreMétodo(int valor1, double valor2) en lugar de,public void nombreMétodo (int valor1, double valor2) obsérvese el espacio en blanco delante de la apertura de paréntesis.

Visibilidad de miembros de clase 1. Los atributos (datos) deben declararse privados (private) excepto los que se pretenda que sean accesibles por herencia que deben ser protegidos (protected). Se debe evitar el uso de datos públicos. Los procedimientos (métodos) de lainterfaz pública deben declararse public, los de soporte privados (private).

2.

Escuela Superior de Informática-UCLM

2

M etodología y Tecnología de la Programación

Identificadores 1. Escoja identificadores significativos y a ser posible breves. En cualquier caso prefiera la claridad a la brevedad. Por ejemplo, es preferible el identificador, integralIndefinida que el de, intInd

2....