BUENAS PRÁCTICAS EN JAVA

1.   No utilice System.out.println – utilice logs.

2.   Importe clases específicamente - no utilizar * imports.

3.   Después de usar bloques try-cach-finally liberar los recursos.

4.   Evite el uso de archivos de propiedades (.properties). Estos archivos al crecer en tamaño y
complejidad, pueden llegar a ser inconsistentes. Los archivos de configuración XML son más
fáciles de organizar, leer y mantener.

5.   Tener cuidado con el uso de "==" vs "equal()" cuando se comparan objetos.

6.   Utilice concatenación de StringBuffer en lugar de concatenación de Strings.

7.   Asignar  null a objetos que ya no se utilizan.

8.   Evite el uso de métodos obsoletos. 

(http://java.sun.com/j2se/1.5.0/docs/api/deprecated-list.html )

9.   Evite el uso de Hashtable y utilice Hashmap en su lugar.

10. Evite el uso de Vector y utilice ArrayList usar en su lugar.

11. No almacene objetos grandes en Sessiones Http.

1/5
BUENAS PRÁCTICAS EN JAVA

12. Libere Sessions http cuando haya terminado de utilizarla.

13. Elimine la concatenación de String “+=”.

NOMENCLATURA

1.   Variables y parámetros: Se deberá utilizar Camel casing para nomenclar variables y
parámetros de métodos.

2.    Constantes: Los nombres de las variables declaradas constantes de clase y de las
constantes ANSI debería ser todo en mayúsculas con las palabras separadas por guiones
bajos ("_"). (Constantes ANSI se debe evitar, para facilitar la depuración.)

3.    Utilizar el prefijo “I” con Camel Casing para nomenclar Interfaces (Ejemplo: IUser).

4.    Paquetes: El prefijo de un nombre de paquete único, siempre se escribe en letras

minúsculas. Tras componentes del nombre del paquete varía de acuerdo a las convenciones
de nomenclatura propia interna de la organización o del proyecto.

5.    No se debe anteponer ningún prefijo que represente el tipo de datos de variables o
constantes.

6.    El nombre del archivo debe coincidir con el nombre de la clase y debe respetar la notación
Pascal Case.

2/5
BUENAS PRÁCTICAS EN JAVA

7.    Use el sufijo exception en clases que extienden excepción.

8.    Nombre métodos utilizando  el par verbo-objeto, como showDialog().

9.    Siga las convenciones para nombrar los métodos de acceso a las propiedades
(Colaboradores internos).

10.    Archivos fuente: Cada programa en Java es una colección de uno o más archivos. El
programa ejecutable se obtiene compilando estos archivos. En cada archivo especifica su
contenido como sigue:
Los paquetes (instrucción package).
Los archivos de biblioteca (Instrucciones import).
Un comentario explicando el objetivo del archivo.
Las clases que defines en ese archivo.

11.     Clases: se deberá utilizar Pascal casing para los nombres de clases.

Cada clase debe ir precedida por un comentario que explique su objetivo. Es recomendable
especificar sus elementos como sigue:
•    Estructura de los objetos. Primero las variables y luego las constantes.
•    Elementos estáticos.
•    Constructores.
•    Métodos públicos y privados.
•    Métodos estáticos.

Dejar una línea en blanco después de cada método.

Todos los elementos deben estar precedidos por public, private o protected. Las variables
deben ser privadas. Los métodos y las constantes pueden ser privados o públicos, según se

3/5
BUENAS PRÁCTICAS EN JAVA

requiera. 12.    Métodos: Se deberá utilizar Camel casing para los nombres de métodos.
Todo método excepto main debe empezar con un comentario en formato javadoc.

13.   Alineación y espacios en blanco: En cualquier caso los elementos más importantes de
ésta son:
Todos los bloques deben estar alineados de tal manera que sean fácilmente distinguibles.
Dentro de un bloque todas las instrucciones van a la misma altura.

14.    En proposiciones compuestas el paréntesis que abre debe ir en la misma línea que
empieza tal proposición. El paréntesis que cierra debe estar sólo en la última línea de la
proposición y a la misma altura que la línea de inicio:

15.    Usa líneas en blanco para separar partes de un método que son lógicamente distintas.

16.    Deja espacios en blanco entre operadores binarios.

17.    Si tu instrucción no cabe en una línea, divídela agregando un nivel de espaciamiento en
la siguiente línea y empezándola con un operador.

COMENTARIOS Y DOCUMENTACIÓN

1.    Con respecto a la documentación se debe incluir lo siguiente:

Un comentario al inicio de cada clase que contenga:
Descripción del objetivo y restricciones de la clase.
Descripción de los datos de entrada que se requieren y de los que obtienen incluyendo el tipo
de dato que se espera.

2.    Al inicio de cada método un comentario que indique el propósito, restricciones, parámetros
y valor que devuelve el método.

4/5
BUENAS PRÁCTICAS EN JAVA

TESTING
 1
de.  
 3.    TestCase:
clases;
casoJUnit.
 Si
deSuma
losUNITARIO
JUnit
Para
atributos
y3.8.1,
JUnit
Resta,
Hacer
de
debemos
unasí
una
TestCase
una
que
clase
clase
hacer
haremos
no
es
deque
son
una
prueba
dos
estas
claros
clase
clases
por
clases
de
aclararlos
cada
test.
dedeclase
prueba
prueba
con
a un
TestSuma
probar.
hereden
comentario
Ejemplo:
yde
TestResta.
la
enclase
sisutenemos
declaración.
TestCase
En eldos

2.    Métodos
estos
Por
prueba
getSuma()
ejemplo,
métodos de test:
testGetSuma().
con
para
empiecen
algunos
probar
Cada
Este
parámetros
el
pormétodo
método
método
test***.ygetSuma()
sólo
probará
comprobar
tienealguna
que
deque
lainstanciar
clase
cosa
el resultado
de
Suma,
la
la clase.
clase
vamos
es elSuma,
JUnit
esperado.
a hacer
3llamar
requiere
un al
método
método
que de

volver

5/5