Documentación técnica y manual de buenas prácticas para el desarrollo
En este apartado se establecen las reglas de buena práctica y glosario de tecnologías vigentes. Cada desarrolladora o desarrollador que participe del proyecto, deberá seguir a rajatablas tanto las prácticas como las reglas. Es un contrato tácito que regirá como norma de convivencia laboral.
Buenas prácticas para el dearrollo de código
Nombres Descriptivos: Usa nombres de variables, funciones y clases que sean descriptivos y claros. Evita abreviaturas confusas.
Modulación de código: Divide tu código en funciones y clases más pequeñas y cohesivas. Mantén cada función limitada a una tarea específica.
Comentarios Significativos: Añade comentarios donde sea necesario, explicando el propósito y el funcionamiento del código, especialmente en partes complejas.
Usar Constantes: En lugar de valores mágicos, utiliza constantes con nombres descriptivos para mejorar la legibilidad y facilitar futuros cambios.
Evitar la Duplicación de Código: No repitas bloques de código similares. Crea funciones reutilizables cuando sea necesario.
Manejar correctamente las Excepciones: Implementa un manejo adecuado de excepciones. No ignores las excepciones, y captura solo las necesarias.
Mantener un Estilo de Código Consistente: Sigue un estilo de codificación consistente en todo el proyecto. Esto incluye la indentación, el uso de espacios en blanco y las convenciones de nomenclatura.
Sigue el Principio SOLID: Aplica los principios SOLID (Single Responsibility, Open-Closed, Liskov Substitution, Interface Segregation, Dependency Inversion) para crear código modular y fácil de mantener.
Optimización Eficiente: Optimiza el código solo cuando sea necesario y basándote en mediciones reales de rendimiento. La optimización prematura puede aumentar la complejidad innecesariamente.
Buenas prácticas para el desarrollo de BD
Planificación de la Estructura: Antes de comenzar a diseñar la base de datos, planifica cuidadosamente su estructura. Identifica las tablas necesarias y las relaciones entre ellas.
Normalización de Datos: Aplica principios de normalización para evitar la redundancia de datos. Esto garantiza la integridad de los datos y facilita las actualizaciones.
Nombres de Tablas y Columnas Significativos: Usa nombres de tablas y columnas descriptivos y significativos para que sea claro lo que contienen.
Tipos de Datos Adecuados: Selecciona los tipos de datos apropiados para cada columna. Esto ayuda a ahorrar espacio y mejora la eficiencia de las consultas.
Manejo de Errores: Implementa una estrategia de manejo de errores sólida para tratar situaciones inesperadas, como violaciones de restricciones de clave única.
Backup y Restauración: Planifica y automatiza procesos de backup y restauración de la base de datos para evitar la pérdida de datos críticos.
Índices Estratégicos: Crea índices en columnas utilizadas con frecuencia en consultas. Sin embargo, no te excedas, ya que demasiados índices pueden afectar el rendimiento.
Actualizaciones Incrementales: Utiliza transacciones para garantizar actualizaciones consistentes de datos. Las transacciones son esenciales cuando se trabaja con datos críticos.
Optimización de Consultas: Perfila y optimiza las consultas SQL para mejorar el rendimiento de las operaciones de lectura y escritura en la base de datos.
Recuerda que el diseño de la base de datos es fundamental para el rendimiento y la escalabilidad de tu aplicación Android. Planificar y seguir buenas prácticas desde el principio puede ahorrarte muchos problemas a largo plazo.
Glosario de tecnologías y versiones
Desarrollo Mobile: Desarrollo en Lenguaje Kotlin para celular con motor operativo 'Android'
IDE: Android Studio Giraffe | 2022.3.1 Patch 1 Build #AI-223.8836.35.2231.10671973, built on August 17, 2023 Runtime version: 17.0.6+0-b2043.56-10027231 amd64 VM: OpenJDK 64-Bit Server VM by JetBrains s.r.o. Windows 11 10.0 GC: G1 Young Generation, G1 Old Generation Memory: 1280M Cores: 8 Registry: external.system.auto.import.disabled=true ide.text.editor.with.preview.show.floating.toolbar=false
Ubicación de paleta de colores