El documento presenta convenciones de codificación para el lenguaje de programación Java. Establece pautas para nombrar clases, métodos, variables, paquetes e importaciones. También proporciona recomendaciones sobre formato de código, incluyendo tabulación, longitud de línea, ruptura de líneas y uso de comentarios.

1. Code Conventions for the Java Programming Language Equipo de Arquitectura

3. Clases/Interfaces Los nombres de clases deberían ser sustantivos, incluyendo mayúsculas y minúsculas con la primer letra de cada palabra interna en mayúscula. Intente mantener los nombres de clases sencillos y descriptivos. Utilice palabras completas y evite usar acrónimos y abreviaturas (a menos que la abreviatura sea ampliamente usada más que la forma completa, tal como URL o HTML). <<class>> Persona atributos métodos

4. Métodos Los nombres de los métodos deberían ser verbos, mezclas de mayúsculas y minúsculas con la primer letra en minúscula y la primer letra de cada palabra interna en mayúscula ( CamelCase ). <<class>> Persona atributos calcularEdad() obtenerRut()

5. Variables Todas las instancias, clases y constantes de clase se escriben usando mayúsculas y minúsculas con la primer letra en minúscula. Las palabras internas comienzan con letras mayúsculas. Los nombres de variable no deben comenzar con caracteres underscore _ o signo de dólar $ , aunque ambos estén permitidos. Los nombres de variables deberían ser cortos pero con un significado claro. La elección de un nombre de variable debería ser mnemónica, es decir, diseñado para indicar al observador casual su utilización. Deberían evitarse los nombres de variable de un solo caracter excepto para las variables temporales. Algunos nombres de variables temporales son i , j , k , m , y n para enteros; c , d , y e para caracteres.

6. Constantes Los nombres de variables declarados como constantes de clase y las constantes ANSI deberían escribirse todas en mayúsculas con palabras separadas por underscores _ . (Las constantes ANSI deberían evitarse, para facilitar la depuración.) static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; static final int GET_THE_CPU = 1;

7. Constantes Los nombres de variables declarados como constantes de clase y las constantes ANSI deberían escribirse todas en mayúsculas con palabras separadas por underscores _ . (Las constantes ANSI deberían evitarse, para facilitar la depuración.) static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; static final int GET_THE_CPU = 1;

9. Declaraciones de clase e interfaz package cl.bch.gwt.consultasaldo.client; Import java.util.Map; /** * Comentarios de Javadoc * */ public class/interface Nombre { Variables de clase(static); Variables de instancia (public, protected, package, private); Constructores (por default primero); Métodos (agrupados por funcionalidad) }

11. Código someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3)); longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // RECOMENDADA longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // EVITAR

12. Código // NO UTILIZAR ESTA TABULACION if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); } // USAR ESTA TABULACION EN SU LUGAR if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); } // O USAR ESTA OTRA if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); }

13. Código Aquí se muestran tres maneras aceptables de escribir expresiones ternarias: alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) ? beta : gamma; alpha = (aLongBooleanExpression) ? beta : gamma;

23. Dudas? Equipo de Arquitectura