Scribd
Cargar
54 vistas3 páginas

Guia Estilo Java

Cargado por

Angel Daniel LG
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
54 vistas3 páginas

Guia Estilo Java

Cargado por

Angel Daniel LG
Derechos de autor
© © All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 3

Universidad Autónoma del Estado de México

Unidad Académica Profesional Tianguistenco


Programación Orientada a Objetos

Guía de estilo: Java


1. Introducción

¿Qué es una guía de estilo?


Una guía de estilo es un conjunto de convenciones y recomendaciones que determinan cómo debe estructurarse
y escribirse el código en un lenguaje de programación específico. Estas guías ayudan a mantener la coherencia
y la legibilidad del código, lo cual es esencial cuando se trabaja en proyectos en equipo o cuando el código será
mantenido a largo plazo.

Importancia de seguir una guía de estilo en proyectos Java


En el desarrollo de software, especialmente en proyectos grandes y colaborativos, es crucial que todos los
desarrolladores sigan las mismas convenciones. En Java, seguir una guía de estilo tiene varios beneficios:
• Legibilidad. Un código bien estructurado y consistente es más fácil de leer y entender, no solo por quien
lo escribió, sino por otros desarrolladores que puedan trabajar en él en el futuro.
• Mantenimiento. Un código que sigue un estándar es más fácil de mantener, ya que los desarrolladores
pueden predecir cómo está organizado y qué esperar en términos de estructura y nomenclatura.
• Prevención de errores. Muchas convenciones de estilo están diseñadas para evitar errores comunes,
como la confusión entre nombres de variables o la incorrecta anidación de estructuras de control.
• Colaboración. En un entorno de desarrollo colaborativo, es esencial que todos los miembros del equipo
escriban código de manera consistente. Esto reduce el tiempo que se dedica a entender y revisar el
código de otros.

Objetivos de la guía de estilo


La guía de estilo de Java tiene como objetivo proporcionar un conjunto claro de reglas y recomendaciones que
permitan:
• Establecer consistencia en la escritura de código.
• Facilitar la lectura y el entendimiento del código, tanto para desarrolladores actuales como futuros.
• Mejorar la calidad del software al reducir la posibilidad de errores y malas prácticas.
• Optimizar el trabajo en equipo, asegurando que todos los desarrolladores sigan las mismas
convenciones y puedan colaborar de manera efectiva.

2. Nombres y Convenciones
• Nombres de Clases y Interfaces
Uso de CamelCase.
Nombres deben ser sustantivos: Cliente, Cuenta.
• Nombres de Métodos
Uso de camelCase.
Verbos que describan la acción: calcularTotal(), getNombre().
• Nombres de Variables
Uso de camelCase.
Nombres descriptivos y concisos.
• Nombres de Constantes
Uso de letras mayúsculas con palabras separadas por guiones bajos: MAX_SIZE,
DEFAULT_TIMEOUT.
3. Estructura del Código
• Indentación (Sangría)
Uso de 4 espacios por nivel de indentación.
No usar tabulaciones.
• Longitud de Líneas
Mantener las líneas con un máximo de 80 a 100 caracteres.
• Espacios en Blanco
Uso de espacios para mejorar la legibilidad (e.g., entre operadores).
• Líneas en Blanco
Uso de líneas en blanco para separar bloques de código o secciones lógicas.

4. Comentarios
• Comentarios de Clase y Método
Uso de Javadoc (/** ... */) para documentar clases y métodos.
Incluir descripciones claras y completas de lo que hace el método o clase.
• Comentarios en Línea
Uso de comentarios (// ...) para explicar lógica compleja.
Evitar comentarios innecesarios o que repitan lo que ya es obvio en el código.

5. Control de Flujo
• Uso de Bloques
Siempre usar {} en estructuras de control como if, for, while.
• Estructuras de Decisión
Prefiere switch sobre múltiples if-else cuando sea apropiado.
• Evitando el Uso de goto
Java no tiene goto, pero evita estructuras que simulen saltos descontrolados.

6. Manejo de Excepciones
• Excepciones Chequeadas (Checked Exceptions)
Las excepciones chequeadas deben ser manejadas por el compilador, ya sea mediante `try-
catch` o declarando `throws`, y suelen estar vinculadas a condiciones externas fuera del control
del programa, como problemas de I/O o acceso a bases de datos: IOException, SQLException y
FileNotFoundException. Las excepciones chequeadas son útiles cuando el fallo es predecible y
manejable, permitiendo al programa recuperarse, como al intentar abrir un archivo inexistente.
• Excepciones No Chequeadas (Unchecked Exceptions)
Las excepciones no chequeadas, heredadas de RuntimeException, no son verificadas por el
compilador y suelen indicar errores de programación como NullPointerException o
ArrayIndexOutOfBoundsException. Las excepciones no chequeadas indican errores de
programación inesperados y es mejor permitir que se propaguen para manejo en un nivel superior
o provocar la falla del programa con un mensaje claro.
• Bloques try-catch-finally
Mantener bloques try-catch concisos.
Siempre cerrar recursos en el bloque finally o usar try-with-resources.
• Lanzamiento de Excepciones
Incluir un mensaje claro al lanzar una excepción (e.g., throw new IllegalArgumentException("El
valor no puede ser negativo");).
7. Buenas Prácticas de Codificación
• Evitar Código Duplicado
Reutilización de código mediante métodos y clases.
• Minimizar la Complejidad
Métodos pequeños y que realicen una sola tarea.
• Uso Adecuado de las Colecciones
Preferir interfaces (List, Set, Map) sobre implementaciones específicas.
• Finalizadores y Recursos
Preferir emplear try-with-resources en lugar de finalize().

8. Formato y Organización del Código


• Organización de Imports
Evitar import * y preferir importar clases específicas.
• Orden de los Componentes en una Clase
✓ Primero las variables estáticas y finales.
✓ Luego las variables de instancia.
✓ Después los constructores.
✓ Finalmente los métodos.

También podría gustarte