lunes, 5 de mayo de 2025

Reglas para escribir código más limpio

1. Usa nombres descriptivos:

  • Elige nombres significativos para variables, funciones y clases.
  • Evita abreviaciones ambiguas (temp1, x) y usa nombres claros (usuarioActual, calcularTotal).
2. Mantén funciones cortas y concisas:
  • Cada función debe realizar una única tarea.
  • Si una función es demasiado larga, divídela en funciones más pequeñas.
3. Evita la duplicación de código:
  • Si ves que repites código en varios lugares, considera convertirlo en una función reutilizable.
  • Aplica el principio DRY ("Don't Repeat Yourself").
4. Escribe código modular:
  • Usa clases y módulos para organizar tu código en bloques lógicos.
  • Evita dependencias innecesarias entre módulos.
5. Usa comentarios de manera estratégica:
  • Explica el por qué, no el cómo del código.
  • Evita comentarios obvios que solo repiten lo que el código ya expresa.
6. Aplica convenciones de estilo.
  • Sigue guías de estilo del lenguaje que usas (como PEP 8 en Python).
  • Mantén una indentación consistente y evita líneas de código demasiado largas.
7. Escribe pruebas (tests):
  • Asegúrate de que tu código funcione correctamente mediante pruebas unitarias.
  • Usa herramientas como pytest en Python o Jest en JavaScript.
8. Maneja errores adecuadamente:
  • Usa excepciones en lugar de chequeos manuales de errores.
  • No ignores errores silenciosamente; proporciona mensajes claros en los logs.
Siguiendo estas reglas, tu código será más mantenible, legible y eficiente.

Espero que esta información les sea útil.

No hay comentarios:

Publicar un comentario

Deja tu comentario: