Estndar de Codificacin para el

Lenguaje de Programacin JavaTM

Sentencias package e import
La primera lnea no-comentario de los ficheros fuente Java es la sentencia package.
Despus de esta, pueden seguir varias sentencias import.

Por ejemplo:

package java.awt;
import java.awt.peer.CanvasPeer;

Partes de la declaracin de una clase o interface

1. Comentario de documentacin de la clase o interface
(/**...*/)

2. Sentencia
class o interface

3. Comentario de implementacin de la clase o interface si fuera necesario
(/*...*/)

4. Orden de Variables
Public
Protected
Prvate
Variables A nivel de paquete (sin modificador de acceso)

5. Constructores

6. Mtodos
Estos mtodos se deben agrupar por funcionalidad ms que por visin o
accesibilidad.




Longitud de la lnea

Evitar las lneas de ms de 80 caracteres, ya que no son manejadas bien por muchas
Terminales y herramientas.



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.
Alinear la nueva lnea con el comienzo de la expresin al mismo nivel de la lnea anterior.

Ejemplos de cmo romper la llamada a un mtodo:

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


Comentarios de comienzo
Todos los ficheros fuente deben comenzar con un comentario en el que se lista el nombre
de la clase, informacin de la versin, fecha, y Derechos de Autor:

Por ejemplo:

/*
* Nombre de la clase
*
* Informacion de la version
*
* Fecha
*
* Derechos de Autor
*/

Comentarios de bloque
Los comentarios de bloque se usan para dar descripciones de ficheros, mtodos, estructuras
de datos y algoritmos.

/*
* Aqui hay un comentario de bloque.
*/

Comentarios de una linea
Pueden aparecer comentarios cortos de una nica lnea al nivel del cdigo que siguen.

if (condicion) {
/* Cdigo de la condicion. */
...
}

Comentarios de remolque
Pueden aparecer comentarios muy pequeos en la misma lnea que describen, pero deben
ser movidos lo suficientemente lejos para separarlos de las sentencias.

if (a == 2) {
return TRUE; /* caso especial */
} else {
return isPrime(a); /* caso gerenal */
}

Comentarios de seccin de cdigo
Se usa para comentar lneas consecutivas para secciones de cdigo.

//if (bar > 1) {
//
// // Hacer algo.
// ...
//}
//else {
// return false;
//}

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

int nivel; // nivel de indentacin
int tam; // tamao de la tabla

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.


Declaraciones de class 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 declaracin
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 "{"


Por ejemplo:

class Ejemplo extends Object {
int ivar1;
int ivar2;
Ejemplo(int i, int j) {
ivar1 = i;
ivar2 = j;
}
int metodoVacio() {}
...
}
Los mtodos se separan con una lnea en blanco

Sentencias simples
Cada lnea debe contener como mucho una sentencia.

Por ejemplo:

argv++; // Correcto
argc--; // Correcto
argv++; argc--; // EVITAR!

Sentencias if, if-else, if else-if else
La clase de sentencias if-else debe tener la siguiente forma:

Por ejemplo:

if (condicion) {
sentencias;
}
if (condicion) {
sentencias;
} else {
sentencias;
}


Sentencias for
Una sentencia for debe tener la siguiente forma:

Por ejemplo:

for (inicializacion; condicion; actualizacion) {
sentencias;
}

Sentencias while
Una sentencia while debe tener la siguiente forma:

Por ejemplo:

while (condicion) {
sentencias;
}







Sentencias do-while
Una sentencia do-while debe tener la siguiente forma:

Por ejemplo:

do {
sentencias;
} while (condicion);


Sentencias switch
Una sentencia switch debe tener la siguiente forma:

Por ejemplo:

switch (condicion) {
case DEF:
sentencias;
break;
case XYZ:
sentencias;
break;
default:
sentencias;
break;
}

Sentencias try-catch
Una sentencia try-catch debe tener la siguiente forma:

Por ejemplo:

try {
sentencias;
} catch (ExceptionClass e) {
sentencias;
}















Convenciones de nombres


Tipos de
identificadores

Reglas para nombras Ejemplos

Paquetes

El prefijo del nombre de un paquete se
escribe siempre con letras en
minsculas.

com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese

Clases

Los nombres de las clases deben ser
sustantivos, cuando son compuestos
tendrn la primera letra de cada palabra
que lo forma en maysculas. Intentar
mantener los nombres de las clases
simples y descriptivas. Usar palabras
completas, evitar acrnimos y
abreviaturas

class Cliente;
class ImagenAnimada;

Interfaces Los nombres de las interfaces siguen la
misma regla que las clases.

interface
ObjetoPersistente;
interface Almacen;

Mtodos

Los mtodos deben ser verbos, cuando
son compuestos tendrn la primera letra
en minscula, y la primera letra de las
Convenciones de Cdigo Java
siguientes palabras que lo forma en
mayscula.

ejecutar();
ejecutarRapido();
cogerFondo();

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.

Nombres comunes para variables
emporales son i, j, k, m, y n para
nteros; c, d, y e para caracteres.
int i;
char c;
miAnchura;

Constantes

Los nombres de las variables declaradas
como constantes deben ir totalmente en
maysculas separando las palabras con
un subguin ("_").
static final int
ANCHURA_MAXIMA =
999;
static final int
COGER_LA_CPU = 1;