Guía Rápida de las Convenciones de Código de Java

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

5. Para separar un operador binario de sus operandos a = b * (c + d – e) para acceder métodos y variables estáticos. descriptivos. 4. */ fontSize 2. (Excepción: Puede 3. Después de una conversión de tipos Mejor utiliza una constante simbólica con nombre. Métodos: Utiliza verbos. Utiliza cuatro espacios como unidad de sangría.) una sangría de 8 espacios (2 tabulaciones). No añadas comentarios para enunciar lo obvio. Ejemplo: la declaración. Haz una ruptura antes de un operador binario Utiliza un espacio: 5. Después de un bloque de declaraciones de variables */ Varios locales /** Javadoc comment */ 1. 5. Comentarios Javadoc: EXIT_ON_CLOSE class Example { 1. Utilízalos para documentar clases. (ver la excepción más adelante) + (f / g). Entre secciones lógicas de código de modo que las instrucciones lógicamente relacionadas estén 2. Entre un operador unario y su operando 3. 1. de la implementación. Después de las comas en las listas de argumentos y dicha instrucción debe estar delimitada por llaves. Ejemplo: 5. Evita las líneas mayores a 80 caracteres. 1. no 2. cuando sean utilizarse una mezcla en el caso de ruptura de código auto-documentado con nombres apropiados y líneas). No sangres las clases e interfaces de primer nivel. // single-line comment setBackground /* single-line comment */ 4. Entre las partes de inicialización. una estructura lógica explícita. clases e interfaces /* escribe la primera letra en minúscula y la primera letra 1. Utiliza el nombre de la clase. // trailing comment 5. interfaces. Entre una palabra clave y un paréntesis izquierdo nivel o un bucle for—contiene una sola instrucción. 2. bloque de código pueden ser útiles. Los comentarios deben proveer información adicional palabra. Si una estructura de control—como una cláusula if 3. Evita codificar directamente constantes literales. Líneas en blanco private void doTask() { 2. 5. Utiliza paréntesis para clarificar el orden de la x = getValue(a + b + c. Sangra un nivel el cuerpo de un método. Deben describir la entidad que está siendo Utiliza una línea en blanco: documentada desde una perspectiva independiente 1. Coloca la llave de cierre en una nueva línea y statement. Si estas reglas hacen confuso el código o hacen que 6. Ejemplos: TextField y MouseListener 3. ) y sus operandos 2. los métodos y las comentarios que presentan un vistazo general de un la primera letra en minúscula y la primera letra de clases interiores. Constantes: Todas con mayúscula con palabras sángrala al nivel de la declaración separadas por guiones bajos. 2. Entre el nombre de un método y un paréntesis izquierdo Estatutos return Estatutos while Estatutos switch . Sangra un nivel las variables. Ruptura de Líneas agrupadas 3. Entre métodos } /** } 3. mejor haz No utilices un espacio: (Excepción: 0. cada palabra interna con mayúscula. 4. (o lista de argumentos) de la línea anterior: 3. Evita las abreviaciones. Después del encabezado de un método * Javadoc comment 4. Una línea en blanco debe preceder a un comentario. 1. 1. expresión y evaluación en expresiones complejas. Coloca la llave de apertura en la misma línea que * block comment de cada palabra interna con mayúscula. Antes de un comentario statements. d + e + f). Cuando una instrucción no cabe en una sola línea: 4. Ejemplo: correspondiente. Los nombres deben ser palabras o frases de palabras. 4. Minimiza la necesidad de comentarios haciendo tu 2. Los 4. Alinea una nueva línea con el inicio de la expresión parámetros 6. Entre el operador punto ( . Variables: Utiliza sustantivos. una mezcla de ambos. cuando sean varios escribe que no es aparente en el código en sí. actualización de un bucle for 8. Utiliza sustantivos. 1 y –1 son aceptables. Clases e interfaces.Sangrado Comentarios de implementación Convenciones de nombres 1. Haz una ruptura después de una coma Espacios excepto cuando el valor inicial es desconocido. varios escribe con mayúscula la primera letra de cada 3. no una referencia. cuando sean varios Llaves para métodos. Una declaración por línea. Una instrucción por línea. 2. Los nombres deben ser cortos pero 2. Utiliza tabulaciones o espacios para sangrar. Elige las rupturas de alto nivel en vez de las de bajo 1. Para separar un operador ternario de sus operandos 7. el código quede sobre el margen derecho. métodos y variables (con ámbito de clase). Inicializa las variables cuando son declaradas.