Mantener el código limpio

Cuando iniciamos un proyecto, intentamos crear un código totalmente limpio, que nos permita hacer un buen mantenimiento de él en el futuro. Pero sin darnos cuenta vamos ensuciandolo con parches a los errores que aparecen o al agregar nuevas funcionalidades que no estaban pensadas previamente, o incluso porque alguien mete las manos sin la más mínima consideración de como deben hacerse las cosas.

Por eso, seguir algunos principios básicos es fundamental para que nuestro código sea más legible, antes de escribir la primera línea de tu código intenta recordarlos, no solo por los demás, sino que te estarás haciendo un favor a ti mismo si en un futuro tienes que volver a revisarlo.

  1. Doctype STRICT: Te asegurarás un código limpio, puesto que no podrás usar propiedades de formato, para eso ya está el CSS. Así te aseguras mantener separado el HTML del CSS.
  2. Cuidado con los caracteres especiales: Todo caracter especial que incorporemos debe estar codificado siguiendo los estandares. Evitaremos errores innecesarios y fáciles de solventar en el validador de la W3C.
  3. Identación del código: A pesar de ser una de las cosas más fáciles de hacer que existe, sobre todo si usas un entorno de desarrollo (Eclipse, Zend Estudio, etc), mucha gente no presta atención y luego el código parece un ir y venir de lineas llevadas por la marejada, dificil de seguir visualmente.
  4. Separación en capas: Es primordial, te aseguras que cada parte está donde debe estar. Contenido, diseño y funcionalidad, cada una en su capa independiente.
  5. Usar los tags correctamente: Conocer y usar correctamente las propiedades de los tags HTML permitirá un código estandar, más fácil para los navegadores y, sobre todo, mejor en términos SEO.
  6. No usar elementos innecesarios: Nunca hagas uso de aquello que no sea necesario, si puedes conseguir el mismo efecto con menos elementos, el código será mucho más limpio y fácil de interpretar. El uso de divs por todas partes puede no ser tan bueno.
  7. Los nombres son importantes: Ni es bueno usar nombres poco descriptivos en el código, ni tampoco es bueno que sean demasiado. Aquello que hoy queda muy bien definido con un nombre puede convertirse en el futuro en un falso amigo (por el nombre parece una cosa, pero resulta ser otra).
  8. Al CSS lo que es del CSS: El encargado de controlar y manejar el diseño es el CSS, todo lo que tenga relación debe estar en un archivo CSS.
  9. Flexibilidad en el CSS: Una forma cómoda de lograr flexibilidad en el CSS es usar class / id en los elementos < body >. Así podemos variar el diseño dependiendo del tipo de etiqueta body que especifiquemos.
  10. Validación: La validación del código nos aydará a cumplir los aspectos básicos que todo código debe tener, por ejemplo asegurarnos que todas las etiquetas estan correctamente cerradas.
  11. El orden lógico: Aunque soy de los que piensan que la lógica debe estar en cada paso de nuesta vida, en la estructura del código es imprescindible. Si el código se lee de arriba a abajo, así deben estar los elementos colocados.
  12. Haz lo que puedas: Intenta hacer siempre todo aquello que puedas hacer para mantener tu código limpio. Como dice el refrán: «No dejes para mañana lo que puedas hacer hoy».

Fuente: Smashing | Vía: aNieto2K

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.