Gua Rpida de las Convenciones de Cdigo de Java

http://java.sun.com/docs/codeconv/

Sangrado Comentarios de implementacin Convenciones de nombres 1. Utiliza cuatro espacios como unidad de sangra. 1. No aadas comentarios para enunciar lo obvio. 1. Los nombres deben ser palabras o frases de palabras. Los nombres deben ser cortos pero 2. Utiliza tabulaciones o espacios para sangrar, no 2. Una lnea en blanco debe preceder a un comentario. descriptivos. Evita las abreviaciones. una mezcla de ambos. (Excepcin: Puede 3. Minimiza la necesidad de comentarios haciendo tu 2. Clases e interfaces. Utiliza sustantivos, cuando sean utilizarse una mezcla en el caso de ruptura de cdigo auto-documentado con nombres apropiados y lneas). una estructura lgica explcita. varios escribe con mayscula la primera letra de cada 3. No sangres las clases e interfaces de primer nivel. 4. Los comentarios deben proveer informacin adicional palabra. Ejemplos: TextField y MouseListener 3. Mtodos: Utiliza verbos, cuando sean varios escribe que no es aparente en el cdigo en s. Los 4. Sangra un nivel las variables, los mtodos y las comentarios que presentan un vistazo general de un la primera letra en minscula y la primera letra de clases interiores. bloque de cdigo pueden ser tiles. cada palabra interna con mayscula. Ejemplo: 5. Sangra un nivel el cuerpo de un mtodo. // single-line comment setBackground /* single-line comment */ 4. Variables: Utiliza sustantivos, cuando sean varios Llaves para mtodos, clases e interfaces /* escribe la primera letra en minscula y la primera letra 1. Coloca la llave de apertura en la misma lnea que * block comment de cada palabra interna con mayscula. Ejemplo: la declaracin. */ fontSize 2. Coloca la llave de cierre en una nueva lnea y statement; // trailing comment 5. Constantes: Todas con mayscula con palabras sngrala al nivel de la declaracin separadas por guiones bajos. Ejemplo: correspondiente. Comentarios Javadoc: EXIT_ON_CLOSE class Example { 1. Utilzalos para documentar clases, interfaces, mtodos y variables (con mbito de clase). Lneas en blanco private void doTask() { 2. Deben describir la entidad que est siendo Utiliza una lnea en blanco: documentada desde una perspectiva independiente 1. Antes de un comentario statements; de la implementacin. 2. Entre mtodos } /** } 3. Despus del encabezado de un mtodo * Javadoc comment 4. Despus de un bloque de declaraciones de variables */ Varios locales /** Javadoc comment */ 1. Evita las lneas mayores a 80 caracteres. 5. Entre secciones lgicas de cdigo de modo que las instrucciones lgicamente relacionadas estn 2. Una instruccin por lnea. Ruptura de Lneas agrupadas 3. Una declaracin por lnea. Cuando una instruccin no cabe en una sola lnea: 4. Inicializa las variables cuando son declaradas, 1. Haz una ruptura despus de una coma Espacios excepto cuando el valor inicial es desconocido. 2. Haz una ruptura antes de un operador binario Utiliza un espacio: 5. Si una estructura de controlcomo una clusula if 3. Elige las rupturas de alto nivel en vez de las de bajo 1. Entre una palabra clave y un parntesis izquierdo nivel o un bucle forcontiene una sola instruccin, 2. Despus de las comas en las listas de argumentos y dicha instruccin debe estar delimitada por llaves. 4. Alinea una nueva lnea con el inicio de la expresin parmetros 6. Utiliza el nombre de la clase, no una referencia, (o lista de argumentos) de la lnea anterior: 3. Para separar un operador binario de sus operandos a = b * (c + d e) para acceder mtodos y variables estticos. (ver la excepcin ms adelante) + (f / g); 4. Para separar un operador ternario de sus operandos 7. Utiliza parntesis para clarificar el orden de la x = getValue(a + b + c, 5. Entre las partes de inicializacin, expresin y evaluacin en expresiones complejas. d + e + f); actualizacin de un bucle for 8. Evita codificar directamente constantes literales. 5. Si estas reglas hacen confuso el cdigo o hacen que 6. Despus de una conversin de tipos Mejor utiliza una constante simblica con nombre. el cdigo quede sobre el margen derecho, mejor haz No utilices un espacio: (Excepcin: 0, 1 y 1 son aceptables.) una sangra de 8 espacios (2 tabulaciones). 1. Entre el operador punto ( . ) y sus operandos 2. Entre un operador unario y su operando 3. Entre el nombre de un mtodo y un parntesis izquierdo Estatutos return Estatutos while Estatutos switch