Índice de Reglas de Estilo

Este documento organiza las reglas de estilo y diseño de la cátedra. La numeración hexadecimal (0x...) permite referenciar fácilmente las reglas durante las correcciones (ej: “Ver regla 0x2001”).

Orden sugerido de lectura¶

Si sos nuevo en Java, te recomendamos este orden:

1. Serie 0x0 (Nomenclatura básica)

2. Serie 0x5 (Estructuras de Control)

3. Serie 0x2 (Diseño OOP básico)

4. Consultar la Serie 0xE (Errores Comunes) antes de entregar los TPs.

0x0 - Nomenclatura y Formato¶

Define cómo nombrar clases, métodos, variables y constantes. Reglas fundamentales de legibilidad.

• 0x0000 - El código y la documentación deben estar libres de errores ortográficos y usar formato Markdown

• 0x0001 - Los nombres de las clases van en CamelloCase [Estándar Java]

• 0x0002 - Los identificadores válidos son solo con alfabéticos [a-zA-Z]

• 0x0003 - Variables, parámetros y variables locales van en dromedarioCase [Convención del Curso]

• 0x0004 - Los nombres de los métodos van en dromedarioCase [Estándar Java]

• 0x0005 - Las constantes van en mayúsculas con SNAKE_CASE [Convención del Curso]

• 0x0006 - Los identificadores deben ser descriptivos

• 0x0006A - [Recomendación Avanzada] [Recomendación] Nomenclatura de interfaces según su propósito

• 0x0007 - Los identificadores booleanos deben usar prefijos interrogativos

0x1 - Documentación y Comentarios¶

Criterios para escribir Javadoc y definir contratos (PRE/POST).

• 0x1000 - La documentación debe seguir el formato Javadoc estándar

• 0x1001 - Las clases, métodos y atributos llevan documentación Javadoc

• 0x1002 - Todas las excepciones que lancemos deben estar documentadas con @throws

• 0x1003[Avanzado] Documentación de prevención de excepciones

• 0x1004 - [Avanzado] Documentación de excepciones indirectas

• 0x1005 - Al documentar, no se indica el tipo de los parámetros o retorno

• 0x1006 - [Avanzado] Las precondiciones deben documentarse con @param o comentarios

0x2 - Diseño de Clases y POO¶

Buenas prácticas de encapsulamiento, visibilidad y responsabilidades.

• 0x2000 - Las clases van en CamelloCase

• 0x2001 - Los atributos van en dromedarioCase y deben ser private

• 0x2002 - La inicialización de los atributos va en el constructor

• 0x2003 - Los paquetes deben comenzar en ar.unrn e ir en minúsculas

• 0x2004 - Implementar equals requiere implementar hashCode

• 0x2005 - equals y hashCode deben ser implementados juntos o no estar

• 0x2006 - Al extender, sobreescribir solo para llamar a super no es correcto

• 0x2007 - Minimizar el código duplicado

• 0x2008 - Los métodos get/set no pueden ser usados para la lógica del problema

• 0x2009 - La utilización de atributos estáticos debe estar justificada

• 0x200A - [Recomendación] Los métodos deben tener idealmente máximo 20-30 líneas de código

• 0x200B - Evitar retornos null cuando sea posible

• 0x200C - No usar métodos getter/setter si violan encapsulamiento

• 0x200D - Las clases deben tener una única responsabilidad (SRP)

• 0x200E - La implementación de equals debe usar Pattern Matching para el cast

• 0x200F - La implementación de equals debe ser primero la de Object

• 0x2010 - La implementación de hashCode debe emplear la librería estándar

• 0x2011 - No exponer detalles internos mediante getters (TP9 - Agenda)

• 0x2012 - Usar Factory Methods para construcción compleja (TP - Agenda)

0x3 - Manejo de Excepciones¶

Estrategias para prevenir, atrapar y propagar errores.

• 0x3000 - Validación previa (Look Before You Leap) antes que excepciones

• 0x3001 - Propagación natural: No atajar si no podés tomar una decisión útil

• 0x3002 - Traducción con contexto

• 0x3003 - Captura terminal en el main (Convención del Curso)

• 0x3004 - Lanzar y atajar excepciones específicas, no las clases base

0x4 - Testing¶

Reglas para estructurar tests unitarios (AAA) y validaciones.

• 0x4000 - El test debe tener el mismo nombre que la clase con Test al final

• 0x4001 - El test debe seguir la estructura AAA (Arrange-Act-Assert)

• 0x4002 - Un único Act: Una llamada a método por cada caso de prueba

0x5 - Estructuras de Control y Flujo¶

Restricciones didácticas y convenciones sobre if, for, while y retornos.

• 0x5000 - Un solo return por método [Restricción Didáctica]

• 0x5001 - Sin usar la asignación compuesta (+=, -=, *=, etc) [Restricción Didáctica]

• 0x5002 - Sin break y continue, en su lugar usen banderas [Restricción Didáctica]

• 0x5003 - Usar parámetros como variables solo si no cambia su significado [Criterio de Diseño]

• 0x5004 - Separación de Responsabilidades: No mezclar I/O (printf, Scanner) con Lógica de Negocio [Criterio de Diseño]

0x6 - Restricciones sobre Programación Funcional¶

Herramientas que se postergan temporalmente por motivos pedagógicos.

• 0x6000 - No usar expresiones lambda ni referencias a métodos

• 0x6001 - No usar la API de Streams ni Collectors

• 0x6002 - No usar métodos funcionales de colecciones ni encadenamiento

0xE - Errores Comunes¶

Repertorio de antipatrones frecuentes observados en las entregas.

• 0xE000 - Precaución con la concatenación de String en lazos

• 0xE001 - Diferenciar el uso de == y equals() para objetos

• 0xE002 - Fugas de recursos por no cerrar streams