Mejores prácticas
Estilo general
Sección titulada «Estilo general»- Usa nombres en español y descriptivos (
obtener_usuario,calcular_promedio). - Prefiere
camelCasepara funciones ysnake_casepara variables largas; mantén la consistencia en todo el archivo. - Añade comentarios solo cuando aclaren la intención del código.
Organización de archivos
Sección titulada «Organización de archivos»- Agrupa funciones relacionadas en módulos y expórtalas explícitamente.
- Coloca los módulos en carpetas permitidas por
quetzal.jsony documenta los permisos requeridos. - Mantén un archivo principal breve que importe la funcionalidad necesaria.
Tipos y mutabilidad
Sección titulada «Tipos y mutabilidad»- Declara siempre el tipo de las variables y evita la mutabilidad a menos que sea imprescindible.
- Para listas y JSON mutables utiliza
vary valida los datos antes de modificarlos. - Usa métodos de conversión (
.entero(),.texto()) en lugar de concatenar o parsear manualmente.
Manejo de errores
Sección titulada «Manejo de errores»- Valida entradas con condicionales antes de ejecutar operaciones críticas.
- Utiliza
intentar/capturaren bloques pequeños para localizar fácilmente la causa del error. - Proporciona mensajes de excepción concretos con instrucciones de solución.
Uso de objetos
Sección titulada «Uso de objetos»- Define atributos privados para mantener invariantes internos y expón métodos públicos bien documentados.
- Emplea miembros
librepara utilidades que no dependen del estado del objeto. - Evita herencias complejas; prefiere composición y módulos reutilizables.
Pruebas manuales
Sección titulada «Pruebas manuales»- Reproduce los ejemplos oficiales en una carpeta
pruebas-iapara validar que el intérprete se ejecute correctamente. - Ejecuta los programas con el binario compilado (
target/release/quetzal archivo.qz) después de cada cambio importante.
Seguir estas prácticas ayuda a aprovechar las características del lenguaje y facilita la colaboración con otros desarrolladores.