rafael-crespo/reglas icon
public
Published on 3/31/2025
Reglas

Reglas temenos

Rules
reglas
## Estándares de Programación en Java - Pautas para el Asistente de Codificación
## Build & Development Commands
- Uso de Interfaces y Métodos: Utiliza interfaces, métodos y funciones de manera adecuada, extendiendo las superclases cuando sea necesario.
- Captura de Parámetros: Captura los parámetros de cualquier método Java con especificaciones válidas y usa comentarios para describirlos.
- Manejo de Excepciones: Maneja todas las posibles excepciones internas con la excepción T24Core.
- Comentarios: Añade comentarios donde la lógica no sea directa. Pregunta siempre si un nuevo programador puede entender el código; si no, cambia la lógica o añade comentarios.
- Nombres Significativos: Usa nombres significativos para variables y métodos.
- Formato de Código: Formatea el código usando atajos de Eclipse (Ctrl+Shift+F) o habilita la formateación automática.
- Uso de Constantes: Usa nombres de variables en mayúsculas con guiones bajos para constantes (e.g., static final string OFS_SOURCE = “TESTOFS”).
- Declaración de Variables: Evita la inicialización de variables de DataAccess y Session en cada sub-método. Declara una variable de instancia, inicialízala en el método principal y úsala en los sub-métodos.
- Métodos Privados: Por defecto, crea todos los sub-métodos como privados. Crea métodos públicos solo si necesitas acceder a ellos desde diferentes clases.
## Testing Guidelines
- Manejo de Excepciones Externas: Todas las interacciones con dispositivos externos deben tener manejo de excepciones con acciones específicas definidas para todas las posibles causas.
- Comentarios en Excepciones: Añade comentarios explicando cómo ocurrió la excepción y qué acción se tomará.
- Registro de Excepciones: Reporta todas las excepciones capturadas y tragadas en los logs del producto usando la clase ExceptionUtility.
## Code Style & Guidelines
- Clases Java: Usa nombres significativos para las clases, incluyendo el nombre del desarrollador o el nombre de la interfaz.
- Registros de Datos: Sigue las convenciones de nombres para registros de datos, como CSD.<TEMPLATENAME> para plantillas y EB-CSD.<ERRORMSGNAME> para mensajes de error.
- Declaración Tardía: Declara las variables locales lo más tarde posible, justo antes de su primer uso, y con el alcance más restringido posible.
- Variables en Bucles: Define las variables usadas dentro de bucles fuera y antes del bucle.
- Nombres Significativos: Usa nombres significativos para las variables locales, evitando nombres de una sola letra excepto para razones técnicas a corto plazo.
- Estilo de Nombres: Usa el estilo firstWordLowerCaseButInternalWordsCapitalized para nombres de variables y evita nombres booleanos negados (e.g., isError en lugar de isNotError).
- Simplicidad: La calidad de un programa se mide por su simplicidad y facilidad de comprensión por otros.
- Comentarios: Añade comentarios genéricos y funcionales para explicar el flujo del programa y el propósito de variables y métodos.
- Límites de Líneas: Los métodos deben tener un máximo de 100 líneas y típicamente no más de 80 líneas.
- Indentación: Usa una indentación de 4 espacios para las líneas de código.
- Espaciado: No debe haber espacio entre el nombre del método y el paréntesis de apertura, y debe haber un espacio entre las declaraciones condicionales y sus paréntesis siguientes.
- 

## Documentation Guidelines 
-