Cuestiones de Estilo

Índice de Reglas de Estilo¶

0x0 - Nomenclatura y Formato¶

• 0x0000 - Sin errores de ortografía y apliquen formato markdown donde sea posible

• 0x0001 - Los nombres de las clases van en CamelloCase

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

• 0x0003 - Variables, parámetros y variables locales van en dromedarioCase

• 0x0004 - Los nombres de los métodos van en dromedarioCase

• 0x0005 - Las constantes van en mayúsculas con SNAKE_CASE

• 0x0006 - Los identificadores DEBEN ser descriptivos

• 0x0006A - Nomenclatura de interfaces según su propósito

• 0x0007 - Los identificadores booleanos deben usar prefijos interrogativos

• 0x0008 - Los identificadores no deben llevar el tipo de lo que procesan

• 0x0009 - Un espacio antes y después de los operadores

• 0x000A - No apilen líneas

• 0x000B - No hacer import paquete.*, solo traer lo que se necesita

• 0x000C - Los números mágicos deben convertirse en constantes nombradas

• 0x000D - Los comentarios deben explicar el “por qué”, no el “qué”

0x1 - Documentación y Comentarios¶

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

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

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

• 0x1003 - Las excepciones de tiempo de ejecución deben documentar cómo evitar su lanzamiento

• 0x1004 - Documenten el lanzamiento indirecto de excepciones propias

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

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

• 0x1007 - Los comentarios TODO deben incluir contexto

0x2 - Diseño de Clases y POO¶

• 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 - Los métodos deben tener 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

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

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

0x3 - Manejo de Excepciones¶

• 0x3000 - No atajar la excepción si no es posible tomar una decisión

• 0x3001 - El main de un programa no debe dejar pasar excepciones checked

• 0x3002 - Qué familia de excepciones se eligió debe estar documentada

• 0x3003 - No atajar una excepción lanzada en el mismo bloque

• 0x3004 - No convertir excepciones checked a unchecked sin justificación

• 0x3005 - Sean específicos con lo que atajan, no está permitido atajar Exception o RuntimeException

• 0x3006 - Situaciones diferentes requieren excepciones diferentes

• 0x3007 - ‘Largo cero’ y null son dos situaciones bastante diferentes

• 0x3008 - Declarar el lanzamiento de una excepción no controlada es un error

• 0x3009 - No está permitido lanzar excepciones base: Exception o RuntimeException

• 0x300A - Mejor prevenir que atajar

• 0x300B - Silenciar una excepción no es la forma de gestionarla

• 0x300C - No está permitido atajar para relanzar sin agregar información útil

• 0x300D - Atajar para hacer algún tipo de print no es gestionar la excepción

0x4 - Testing¶

• 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 - Una llamada a método en cada caso de prueba

• 0x4003 - Los nombres de tests deben ser descriptivos y usar convención test<Accion><Condicion><ResultadoEsperado>

• 0x4004 - Los tests no deben tener lógica condicional

• 0x4005 - Cada test debe ser independiente y poder ejecutarse en cualquier orden

0x5 - Estructuras de Control y Flujo¶

• 0x5000 - Un solo return por método

• 0x5001 - Sin usar la asignación compuesta (+=, -=, *=, etc)

• 0x5002 - Sin break y continue, en su lugar usen banderas

• 0x5003 - Usar parámetros como variables solo si no cambia su significado

• 0x5004 - Los métodos no deben usar printf o Scanner a no ser que sea explícitamente su propósito

• 0x5005 - Evitar anidamiento profundo de condicionales (máximo 3 niveles)

• 0x5006 - Los bucles deben tener condiciones de terminación claras

0x6 - Restricciones sobre Programación Funcional¶

• 0x6000 - No usar expresiones lambda

• 0x6001 - No usar referencias a métodos (method references)

• 0x6002 - No usar la API de Streams

• 0x6004 - No usar métodos funcionales de colecciones

• 0x6005 - No usar Collectors ni operaciones de reducción

• 0x6006 - Preferir bucles for tradicionales o enhanced sobre operaciones funcionales

• 0x6007 - No usar el patrón de composición funcional

0xE - Errores Comunes¶

• 0xE000 - No es correcto concatenar String en un bucle

• 0xE001 - Comparar objetos con == en lugar de equals()

• 0xE002 - No cerrar recursos (archivos, conexiones, etc.)

• 0xE003 - Modificar una colección mientras se itera sobre ella

• 0xE004 - Ignorar el valor de retorno de métodos inmutables

• 0xE005 - Usar float o double para cálculos monetarios o de precisión

• 0xE006 - Usar comparaciones de strings para determinar comportamiento

• 0xE007 - Usar separadores de línea específicos de plataforma