logotipo

img_google

Convenciones de código

El presente documento trata sobre las convenciones en la codificación de programas en Java, estas convenciones son proporcionadas por Sun, en su original en inglés, y fueron traducidas por Alan Ortiz.

He aquí el contenido

1. Introducción
    1.1 ¿Porqué tenemos convenciones de código
    1.2 Reconocimientos

2. Nombres de archivos
    2.1 Sufijos de archivo
    2.3 Nombres de archivo comunes

3. Organización de archivos
    3.1 Archivos fuente en Java
        3.1.1 Comentarios iniciales
        3.1.2 Sentencias de declaración de paquete e importación
        3.1.3 Declaraciones de interfaz

4. Tabulaciones y sangrías
    4.1 Longitud de línea
    4.2 Ajuste de líneas

5. Comentarios
    5.1 Formatos de implementación de comentarios
        5.1.1 Comentarios de bloque
        5.1.2 Comentarios de línea simple
        5.1.3 Comentarios de rastreo
        5.1.4 Comentarios de fin de línea
    5.2 Comentarios de documentación

6. Declaraciones
    6.1 Número por línea
    6.2 Inicialización
    6.3 Ubicación
    6.4 Declaraciones de clase e interfaz

7. Sentencias
    7.1 Sentencias simples
    7.2 Sentencias compuestas
    7.3 Sentencias return
    7.4 Sentencias if, if-else, if-else-if-else
    7.5 Sentencias for
    7.6 Sentencias while
    7.7 Sentencias do-while
    7.8 Sentencias switch
    7.9 Sentencias try-catch

8. Espacios en blanco
    8.1 Líneas en blanco
    8.2 Espacios en blanco

9. Convenciones sobre los nombres

10. Prácticas de programación
    10.1 Proveer acceso a variables de instancia y clase
    10.2 Referenciar variables de clase y métodos
    10.3 Constantes
    10.4 Asignación de variables
    10.5 Prácticas diversas
        10.5.1 Paréntesis
        10.5.2 Retorno de valores
        10.5.3 Expresiones antes del operador condicional "?"
        10.5.4 Comentarios especiales

11. Ejemplo de código
    11.1 Ejemplo de código fuente Java