Desarrollo de sistemas

Octavio Csar Escobar Jaramillo Convenciones de programacin java

Convenciones de cdigo para el lenguaje de programacin Java

Las convenciones de cdigo son importantes para los programadores por un gran nmero de
razones:

El 80% del coste del cdigo de un programa va a su mantenimiento.

Casi ningn software lo mantiene toda su vida el auto original.
Las convenciones de cdigo mejoran la lectura del software, permitiendo entender cdigo
nuevo mucho ms rapidamente y ms a fondo.
Al distribuir cdigo fuente como un producto, se debe asegurar de que est bien hecho y
presentado como cualquier otro producto.

1. Extensiones de archivos

Java utiliza las siguientes extensiones para sus archivos:

Tipo de archivo Extensin

Fuente Java .java
Bytecode de java .class

2. Cometarios de inicio

Todos los archivos fuente deben comenzar con un comentario en el que se lista el nombre de la
clase, informacin de la versin, fecha, y copyright:

/*
* Nombre de la clase *
* Informacion de la version *
* Fecha
*
* Copyright
*/

3. Identacin

Se deben emplear cuatro espacios como unidad de indentacin. La construccin exacta de la

indentacin (espacios en blanco contra tabuladores) no se especifica. Los tabuladores deben ser
exactamente cada 8 espacios (no 4).

3.1 Longitud de la lnea

Evitar las lneas de ms de 80 caracteres, ya que no son manejadas bien por muchas terminales y
herramientas.
 Desarrollo de sistemas
Octavio Csar Escobar Jaramillo Convenciones de programacin java

Nota: Ejemplos para uso en la documentacin deben tener una longitud inferior, generalmente no
ms de 70 caracteres.

3.2 Rompiendo lneas

Cuando una expresin no entre en una lnea, romperla de acuerdo con estos principios:
Romper despus de una coma.
Romper antes de un operador.
Preferir roturas de alto nivel (ms a la derecha que el "padre") que de bajo nivel (ms a la
izquierda que el "padre").
Alinear la nueva linea con el comienzo de la expresion al mismo nivel de la linea anterior.
Si las reglas anteriores llevan a cdigo confuso o a cdigo que se aglutina en el margen
derecho, indentar justo 8 espacios en su lugar.

Ejemplos de como romper la llamada a un mtodo:

unMetodo(expresionLarga1, expresionLarga2, expresionLarga3,
expresionLarga4, expresionLarga5);

var = unMetodo1(expresionLarga1,
unMetodo2(expresionLarga2,
expresionLarga3));

3.3 Comentarios

Los programas Java pueden tener dos tipos de comentarios: comentarios de implementacin y
comentarios de documentacin. Los comentarios de implementacin son aquellos que tambin se
encuentran en C++, delimitados por /*...*/, y //. Los comentarios de documentacin (conocidos
como "doc comments") existen slo en Java, y se limitan por /**...*/. Los comentarios de
documentacin se pueden exportar a ficheros HTML con la herramienta javadoc.

Los comentarios de implementacin son para comentar nuestro cdigo o para comentarios acerca
de una implementacin particular. Los comentarios de documentacin son para describir la
especificacin del cdigo, libre de una perspectiva de implementacin, y para ser leidos por
desarrolladores que pueden no tener el cdigo fuente a mano.

Se deben usar los comentarios para dar descripciones de cdigo y facilitar informacin adicional
que no es legible en el cdigo mismo. Los comentarios deben contener slo informacin que es
relevante para la lectura y entendimiento del programa. Por ejemplo, informacin sobre como se
construye el paquete correspondiente o en que directorio reside no debe ser incluida como
comentario.

Son apropiadas las discusiones sobre decisiones de diseo no triviales o no obvias, pero evitar
duplicar informacin que esta presente (de forma clara) en el cdigo ya que es fcil que los
 Desarrollo de sistemas
Octavio Csar Escobar Jaramillo Convenciones de programacin java

comentarios redundantes se queden desfasados. En general, evitar cualquier comentario que
pueda quedar desfasado a medida que el cdigo evoluciona.

Nota: La frecuencia de comentarios a veces refleja una pobre calidad del cdigo. Cuando se sienta
obligado a escribir un comentario considere reescribir el cdigo para hacerlo ms claro.
Los comentarios no deben encerrarse en grandes cuadrados dibujados con asteriscos u otros
caracteres.

Los comentarios nunca deben incluir caracteres especiales como backspace.

4. Declaraciones

4.1 Cantidad por lnea

Se recomienda una declaracin por lnea, ya que facilita los comentarios. En otras palabras, se
prefiere

int nivel; //nivel de identacin

int tam; //tamao de tabla

antes que:
int nivel, tam;

4.2 Inicializacin

Intentar inicializar las variables locales donde se declaran. La nica razn para no inicializar una
variable donde se declara es si el valor inicial depende de algunos clculos que deben ocurrir.

4.3 Declaracin de clases e interfaces

Al codificar clases e interfaces de Java, se siguen las siguientes reglas de formato:

Ningn espacio en blanco entre el nombre de un mtodo y el parntesis "(" que abre su
lista de parmetros
La llave de apertura "{" aparece al final de la misma lnea de la sentencia declaracion
La llave de cierre "}" empieza una nueva lnea indentada para ajustarse a su sentencia de
apertura correspondiente, excepto cuando no existen sentencias entre ambas, que debe
aparecer inmediatamente despus de la de apertura "{"
Los mtodos se sepaan con una lnea en blanco

4.4 Sentencias

Cada lnea debe contener como mucho una sentencia. Ejemplo:

argv++; //correcto
argc--; //correcto
 Desarrollo de sistemas
Octavio Csar Escobar Jaramillo Convenciones de programacin java

argv++; argc--; //evitar!


5. Lneas en blanco

Las lneas en blanco mejoran la facilidad de lectura separando secciones de cdigo que estn
lgicamente relacionadas.
Se deben usar siempre dos lneas en blanco en las siguientes circunstancias:
Entre las secciones de un fichero fuente
Entre las definiciones de clases e interfaces.
Se debe usar siempre una lnea en blanco en las siguientes circunstancias:
Entre mtodos
Entre las variables locales de un mtodo y su primera sentencia
Antes de un comentario de bloque o de un comentario de una lnea
Entre las distintas secciones lgicas de un mtodo para facilitar la lectura.


6. Convenciones de nombres

Las convenciones de nombres hacen los programas ms entendibles haciendolos ms fcil de leer.
Tambin pueden dar informacin sobre la funcin de un indentificador, por ejemplo, cuando es
una constante, un paquete, o una clase, que puede ser til para entender el cdigo.

Tipos de i Reglas para nombrar Ejemplos
dentificadores
Paquetes El prefijo del nombre de un paquete se escribe
siempre con letras ASCII en minsculas, y debe ser
uno de los nombres de dominio de alto nivel,
actualmente com, edu, gov, mil, net, org, o uno de
los cdigos ingleses de dos letras que identifcan com.sun.eng
cada pas como se especifica en el ISO Standard com.apple.quicktime.v2
3166. edu.cmu.cs.bovik.cheese

Los subsecuentes componentes del nombre del
paquete variarn de acuerdo a las convenciones de
nombres internas de cada organizacin. Dichas
convenciones pueden especificar que algunos
nombres de los directorios correspondan a
divisiones, departamentos, proyectos o mquinas.
Clases Los nombres de las clases deben ser sustantivos,
cuando son compuestos tendrn la primera letra
de cada palabra que lo forma en maysculas. class Cliente;
Intentar mantener los nombres de las clases class ImagenAnimada;
 Desarrollo de sistemas
Octavio Csar Escobar Jaramillo Convenciones de programacin java

simples y descriptivos. Usar palabras completas,
evitar acrnimos y abreviaturas (a no ser que la
abreviatura sea mucho ms conocida que el
nombre completo, como URL or HTML).
Interfaces Los nombres de las interfaces siguen la misma interface
regla que las clases. ObjetoPersistente;
interface Almacen;
Mtodos Los mtodos deben ser verbos, cuando son
compuestos tendrn la primera letra en minscula, obtenerFondo();
y la primera letra de las siguientes palabras que lo
forma en mayscula.
Variables Excepto las constantes, todas las instancias y
variables de clase o mtodo empezarn con
minscula. Las palabras internas que lo forman (si
son compuestas) empiezan con su primera letra en
maysculas. Los nombres de variables no deben
empezar con los caracteres subguin "_" o signo Int i;
del dolar "$", aunque ambos estan permitidos por char c;
el lenguaje. float miAnchura;

Los nombres de las variables deben ser cortos pero
con significado. La eleccin del nombre de una
variable debe ser un mnemnico, designado para
indicar a un observador casual su funcin. Los
nombres de variables de un solo caracter se deben
evitar, excepto para variables ndices temporales.
Nombres comnes para variables temporales son i,
j, k, m, y n para enteros; c, d, y e para caracteres.
Constantes Los nombres de las variables declaradas como static final int
constantes deben ir totalmente en maysculas ANCHURA_MINIMA = 4;
separando las palabras con un subguin ("_"). (Las
constantes ANSI se deben evitar, para facilitar su static final int
depuracin.) ANCHURA_MAXIMA =
999;