Estándares de desarrollo

From MoonDragon Wiki

Para una mejor organización y orden al trabajar en MoonDragon, pedimos a nuestros desarrolladores y colaboradores que respeten estos estándares:

• Utiliza nombres descriptivos para tus variables y funciones. Si existe riesgo de confundirla con otra variable o nombre ya existente dentro del sistema agregale un parámetro descriptivo como $variable_modulo5. Lo importante es que cuando otros lean tu código entiendan el propósito de esa variable o función.
• Utiliza comentarios para describir que hacen tus funciones, nadie debe necesitar leer toda tu función para comprenderla. Si es posible, utiliza un estilo de comentarios compatible con Doxygen.
• Mantén tu código limpio y fácil de entender. No utilices soluciones mágicas de una sola línea, indenta tu código y utiliza espacios entre las variables y los operadores. Te invitamos a que revises este artículo.
• No mezcles diferentes lenguajes de programación en un solo archivo. Utiliza plantillas para el html y coloca el css y el javascript archivos separados. El framework proporciona funciones que facilitan la separación de código, te invitamos a que las uses cuando sean necesarias.
• Utiliza en todo momento el principio KISS, orientado tanto al usuario como para los otros desarrolladores.

Queremos también que recuerden en todo momento que MoonDragon es producto de la colaboración de varias personas y que todos tenemos nuestras propias prioridades y problemas. En caso de que surja cualquier inconveniente es mejor hablar las cosas con calma para poder llegar a una solución.

Scripts de Acción

Los scripts de acción son los que realizan las acciones dentro del cms, todo procesamiento de datos tiene que hacerse a través de un script de acción. Cada sección del sitio se asocia a un script y éste se reutilizaría entre las secciones que tengan el mismo procesamiento de los datos, aunque los datos sean diferentes.

Es importante distinguir el uso de datos diferentes entre distintas secciones, para no crear secciones repetidas al reutilizar el script.

Odin 23:50 18 abr 2008 (UTC)