Abr
4
7 tips para mejorar tu código
Filed Under Informática, Internet | 3 Comments
Esto es un llamado a la solidaridad para la comunidad de programadores php y para los que intentan serlo. Porque uno llega a tal punto que se cansa de renegar con código ajeno. Realmente al que no le gusta programar, que no programe, no le complique la vida a los demás, a los que SI quieren tener códigos limpios.
A lo que quiero llegar con esto es que, en todas las empresas en las que me tocó trabajar como desarrollador, inclusive en la que estoy actualmente, existe el código basura. Ese código hecho a las apuradas y en duro (hard code) sólo sirve para pasar el momento y salvarse uno mismo, digámosle: EL GRAN PARCHE. Pero tienen que pensar de que es muy probable que ese sistema siga desarrollándose y quizás por otro programador. Es ahí cuando entra el problema, si todo el tiempo estamos parcheando, no comentamos nuestro código, no dividimos las capas del desarrollo (MVC), duplicamos código, etc, la persona que nos suceda tiene que seguirlo, y va a renegar el doble para saber qué demonios hemos querido hacer, entonces como los tiempos de entrega muchas veces son cortos, a este otro programador no le queda otra que seguir parcheando y así sucesivamente. Hasta que, el sistema, llega a ser un MONSTRUO (como dijo un amigo), pero un monstruo hecho de parches, que tarde o temprano nos va a dominar y le perderemos el control.
Asi es que, para que no sigan ocurriendo estas horripilantes situaciones, voy a dar un par de tips fundamentales, que pueden ayudar a la hora del desarrollo, y de esta forma mejorar nuestro código:
1. Conexión a la base de datos:
Los datos de las conexiones deben estar en un archivo único, para que puedan ser utilizados por cualquier scripts que necesite el uso de la base de datos (muchas veces usado para AJAX). Preferentemento utilizar constantes para este caso, ya que una variable podría sobreescribir el dato y darnos conflicto, pero no eso no es indispensable. Nunca, nunca, pero nunca, duplicar esos datos, ya que si cambian, vamos a tener que modificar en cada archivo que se seteó.
2. Framework:
Utilizar siempre algún framework que divida en capas al sistema en Modelo, Vista y Controlador (MVC). Este patrón de arquitectura nos dará la flexibilidad de separar los datos de una aplicación en tres componentes. La vista, vendría a ser dónde se encuentran los archivos HTML, el modelo es el sistema de gestión de base de datos y el controlador representa la lógica de negocio. No complicarse con frameworks que tienen muchas clases y funciones personalizadas, las cuales tendremos que aprendernos un flor de tutorial, para saber para qué sirve cada cosa y ya estaríamos usando un pseudo-lenguaje y eso no nos beneficiaría en nada. Tiene que ser simple. Les recomendaría que vean este sistema MVC que se encuentra disponible en phpit.net. Pueden descargar el sistema ya armado desde aquí. DESCARGAR SISTEMA MVC.
También puedes realizar tu propio framework si quieres, eso depende de cada uno.
3. Usar objetos:
Teniendo PHP 5, debemos usar objetos, es algo obvio. No podemos hacer un sistema de usuarios y no tener un objeto “usuarios”, por decir. La programación orientada a objetos expresa un programa como un conjunto de estos objetos, que colaboran entre ellos para realizar tareas. Esto permite hacer los programas y módulos más fáciles de escribir, mantener y reutilizar.
4. Comentar código:
Dejar documentado el código es muy importante para que otros programadores puedan entender lo que has hecho. Muchas veces encontrarás clases y librerías que son un amor, pero si no sabes como utilizarla no sirve de nada.
5. Cada cosa en su lugar:
Los archivos CSS deben estar en una carpeta, los archivos Javascript en otra carpeta, las imágenes en otra carpeta, y así. No mezclar los archivos.
6. Sintaxis alternativa:
Para la vista, o sea los archivos HTML, en caso de tener que poner código PHP en él, se puede utilizar la sintaxis alternativa, que para algo se hizo, y por lo tanto la usemos. Esta sintaxis altenativa nos servirá para alguna de sus estructuras de control: if, while, for, foreach, y switch. En cada caso, la forma básica de la sintaxis alternativa es cambiar la llave de abertura ({) por dos puntos (:) y la llave que cierra por endif;, endwhile;, endfor;, endforeach;, o endswitch;, respectivamente.
Ejemplo:
Esto será útil también para no complicarle la vida a los diseñadores, ya que verán poco código PHP y les será más sencillo hacer sus modificaciones. Que quede claro que en la vista no debes setear ninguna variable, la vista sólo sirve para mostrar la información. Por eso tiene que tener la menor cantidad de código PHP posible.
7. No duplicar código:
Esto es algo fundamental, y que muchos lo pasan de largo. Por ejemplo si tienes que hacer un sitio web en dos idiomas, por favor JAMÁS dupliques el código teniéndola en dos carpetas, de esa forma tendríamos dos sitios que mantener. Eso no se hace, imaginate a la hora de tener que hacer una modificación, tendríamos que hacer el doble de trabajo. La forma más práctica es utilizar archivos con constantes que contengan el texto de cada idioma y manejarse con sesiones.
También hay que ver los pequeños detalles que tampoco tienen que duplicarse: pies de páginas (footer), encabezados (header), barras laterales (sidebar), estilos, scripts, etc.
La idea básica de esto es poder tener siempre, códigos limpios y reutilizables. Si en algún momento te dan un sitio ya comenzado por otro programador, y ves que es código apesta, tienes que ponerte firme y pedir la restauración de ese sistema. No nos compliquemos más con códigos viejos y duros. Ya sé que toda empresa piensa “money, money, money” y “no hay tiempo”. Pero hay que prestar atención también en “la inversión de tiempos”. Que eso daría más dinero, aunque siempre están las empresas conformistas, pero eso es otro tema.
Cuando un programador pregunta: ¿Lo hago bien o lo hago rápido?. La respuesta de la empresa es: rápido. Y ahí comienzan los parches, dándole pié a que el MONSTRUO se vaya armando. La solución a esto es darle ese tiempito al desarrollador para que realice bien su trabajo y servirá para evitar tiempos de arreglo en un futuro que darán pérdidas seguras.
Espero que les sea útil, ya que por cada punto puesto en práctica salvaremos a un desarrollador de no volverse loco con código ajeno.
Comentarios
3 Responses to “7 tips para mejorar tu código”
Leave a Reply
Publicidad
Feed Links
Abril 23rd, 2008 at 9:17 am
No duplicar codigo creo que resume otras de las cosas mencionadas antes….el problema es cuando se vuelve una obsecion y termina llevando más tiempo y haciendo las cosas peor….no se si compartes mi pensamiento…aunqeu no soy una experta programadora, hace poco que empiezo y he hecho solo algunas cositas en php.
bueno, te cuento que soy Ana Lucia de http://chiflame.net/, un meneame argentino que creamos con un compa de la facu para ayudar a los bloggers a que puedan conseguir enlaces y aumentar las visitas a sus blogs, un beso
Abril 4th, 2008 at 12:40 pm
Si, es verdad, los nombres de las funciones son muy importantes. Yo prefiero tener una función que se llame obtener_todos_los_registros_de_la_base_de_datos() a tener una función que se llame funcion1()
Abril 4th, 2008 at 12:20 pm
Excelete! Que facil sería la vida si todo fuera asi! Agregaría 2 cositas:
1. Indentar el codigo (esto hace MUCHO mas facil la lectura) y
2. Ponerles nombres significativos a las funciones y variables (por ej, si tenemos una función que calcula la edad de una persona de acuerdo a su fecha de nacimiento deberiamos llamarla algo asi como “calcularEdad()” y no “ce()” o “funcion1()” o nombres que no nos den una pista de que hace la funcion).
Y recuerden: “Un código bien escrito es la mejor documentación”.