Tecnología - Arquitectura SOA - Parte II. Mejores prácticas para Codificación en JAVA...

Continuando con las mejores prácticas para desarrollar en JAVA tenemos...
Comentarios Iniciales
Cada archivo .java debe contener comentarios iniciales con el formato especificado,
se encuentra en formato javadoc, y debe contener al menos los siguientes datos:

1. Descripción
2. Autor


Declaraciones de clases e interfaces

Las declaraciones de clases e interfaces se estructurarán de la siguiente forma:

Declaración de Variables

Las variables se declaran, en primer lugar, de acuerdo a su tipo de acceso en el siguiente orden:
public
protected
private
package protected

En segundo lugar se declaran de acuerdo a los modificadores, en el siguiente orden:
static
final
transient
volatile.

Declaración de Constructores

Si la clase no requiere un constructor particular se recomienda no definirlo para que el compilador genere el constructor vacío por defecto.
Si la clase utiliza un constructor con parámetros, es imperativo que se defina al menos el constructor vacío por defecto.
Los parámetros del constructor que sirvan para inicializar atributos de la clase, deberán llamarse igual que el atributo y se utilizará el identificador “this” para distinguirlos.

Declaración de Métodos

• os métodos se ordenarán por acceso y alfabéticamente.

• Los nombres de los métodos se escribirán seguidos del paréntesis de la lista de parámetros, sin dejar espacio.

• Los métodos se separarán por una línea.

• El cuerpo de la función y/o procedimiento debe ir comprendido entre las llaves de apertura y cierre {...}. Cada llave debe permanecer sin ninguna otra definición sobre la línea.

• Los métodos deben documentarse con javadoc.

• Las excepciones checadas deben documentarse.

• Las excepciones de tipo Runtime deben documentarse si son relevantes para el usuario del API (como el caso de IllegalAccessException, InvocationException)

• Los métodos que implementen las definiciones de las interfaces se puede utilizar la notación {@inheritDoc}

Declaración de Clases Internas

Las clases internas sólo deberán utilizarse cuando su uso únicamente sea exclusivo en la clase, es decir si una clase interna es accedida por otra clase deberá sacarse en otro archivo java.

• Las clases internas deberán ser private static final.

• Las clases internas deberán implementar alguna interface o extender una clase abstracta, en caso de que sólo sean una bean/pojo deberá sacarse a otro archivo java.

Indentación de Código

La indentación del código es de dos espacios.

No se deben utilizar tabuladores por la diversidad de trato que ofrecen los editores que existen sobre este carácter.

Se debe utilizar una sola línea por cada declaración de datos y cada línea programada a menos que la sentencia enriquezca la legibilidad.

Evitar las líneas de más de 80 caracteres.

Cuando una expresión no entre en una línea, éste se romperá de acuerdo a los siguientes principios: 1. Después de una coma

2. Antes de un operador

3. Indentar a la altura de donde empieza la expresión

Sentencias de Flujo

El código incluido en las sentencias de control, debe cumplir con el criterio de indentación definido. Adicionalmente debe cumplir con los siguientes lineamientos:

Una sola sentencia por línea de código

1. Al utilizar la sentencia return, no utilizar paréntesis a menos que el valor de retorno no sea obvio.

2. Considerar el uso de caracteres { } aún y cuando solamente sea una línea la que sea procesada en la sentencia de control.

3. Los caracteres { } deberán estar indentados al mismo nivel de la sentencia correspondiente, por ejemplo

Que es Javadoc?

Es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java.

Javadoc es el estándar de la industria para documentar clases de Java, la mayoría de los IDEs los generan automáticamente

Creación de objetos

Se deben crear las instancias de los objetos inmediatamente antes de ser utilizados.

Evitar la creación de instancias de los objetos cuando no van a utilizarse inmediatamente; es decir, no usar el estilo de programación estructurada de C.