CONVENCIONES DE CDIGO

El 80% del costo de un programa es destinado al mantenimiento, las convenciones mejoran la

lectura del software, y as entender nuevo cdigo mucho ms rpido.

Se debe asegurar primero que este bien hecho el cdigo, antes de presentar el producto.

El programa java utiliza .class y .java como extensiones de ficheros, donde (.class) es la
compilacin del programa a lenguaje de mquina.

Los nombres de ficheros ms comunes son (GNUmakefile) que es preferido para ficheros
make para construir nuestro programa y (README) utilizado para resumir un directorio
particular.

La organizacin de los ficheros debe estar de la siguiente manera:

- Separados por lneas en blanco.

- Comentarios que identifiquen cada seccin(Opcional)
- Ficheros de ms de 2000 lneas deben ser evitados.

Cada fichero fuente java contiene una clase o interface publica, cuando algunas clases privadas
estas asociadas a una clase publica, pueden colocarse en el mismo fichero de la clase pblica,
por lo tanto, tiene la siguiente ordenacin.

- Comentarios de comienzo
- Sentencias package e import
- Declaraciones de clases o interfaces.

Todos los ficheros fuente deben listar el nombre de la clase, informacin de la versin, fecha y
copyright.

Ejemplo:

/*

* Nombre de la clase

* Informacin de la versin

* fecha

* Copyright

*/

Sentencias package e import: primera lnea no comentada, a continuacin de esto pueden

seguir varias sentencias import. Por ejemplo:

Package java.awt;

Import java.awt.peer.CanvasPeer;

Declaraciones de clases de interfaces:

1) Comentario de documentacin de la clase describen clases Java, interfaces,

construcciones, mtodos y atributos. Cada comentario se cierra con los
delimitadores /***/.
2) Sentencia: clase o interface.
 CONVENCIONES DE CDIGO
3) Comentario de implementacin de la clase: debe contener cualquier informacin
aplicable a toda la clase o interface, que no es apropiada para estar en los comentarios.
4) Variables de clase (static): primero variables de clase public, despus las protected,
despus las de nivel de paquete (sin modificador de acceso), y despus las private.
5) Mtodos: deben de estar agrupados por funcionalidad ms que por visin.

Se debe emplear cuatros espacios como unidad de indentancin.

Evitar las lneas de ms de 80 caracteres, ya que no se manejan bien por muchos terminales.

Romper lneas de acuerdo con estos principios: romper despus de una coma.

romper antes de un operador.

preferir roturas de alto nivel, que de bajo nivel.

alinear la lnea con la expresin al mismo nivel de la lnea anterior.

Se recomienda una declaracin por lnea ya que facilita los comentarios.

Intentar iniciar las variables locales donde se declara, poner las declaraciones solo al principio
del bloque o bloques.

Al codificar las clases hay que seguir las siguientes reglas: ningn espacio en blanco entre el
nombre o el mtodo. Llave de apertura y de cierre.

En las sentencias simples cada lnea debe contener como mucho una sentencia.