Que tal amigos, en este post hablaremos un poco acerca de algunas de las buenas prácticas que debemos de tener en cuenta a la hora de desarrollar cualquier proyecto en el mundo de la programación.

A veces por cuestiones de tiempo de entregas, no prestamos atención a pequeños detalles que nos pueden hacer la vida más fácil a la hora de darle mantenimiento a nuestra aplicación o cuando nos toca agregar nuevas funcionalidades, miramos atrás y no recordamos como hicimos algo, vemos una variable y no recordamos para que la definimos o que es lo que hace aquella función llamada X() , pues aquí les dejo con algunos de los tips que nos pueden ayudaran con este tipo de situaciones.

Evitar código espagueti

Se le suele llamar código espagueti cuando dentro de un solo archivo fuente encuentras de todo un poco, como por ejemplo, conexiones a bases de datos, funciones, clases y la vista del cliente, por lo cual, este tipo de código da la sensación de que todo está mezclado, como un plato de espagueti.

Ejemplo extraído desde Wikipedia

<?php
$a=1;
$b=2;
echo '<html>';
echo '<head>';
echo '</head>';
echo '<body>';
echo '<form action="pr2.php">';
if ($a+$b==1) {
    echo' <p>Nombre<input type="text" name="nombre" value="" /></p>';
    echo' <p>Apellido <input type="text" name="apellido" value="" /></p>';
} else {
    echo' <p>Telefono<input type="text" name="telefono" value="" /></p>';
    echo' <p>Direccion <input type="text" name="direccion" value="" /></p>';
}
echo' </FORM> ';
echo ' </body>';
echo '</html>';
?>

A la hora de programar es recomendable tener por separado los componentes de nuestra aplicación, de esta forma, podemos actualizar la librería que maneja la base de datos sin afectar la vista que se presenta al usuario final. En resumen, mantener por separado lo funcional de la presentación lo cual hará mas fácil el mantenimiento de la aplicación.

Comentarios

Hoy en día no se presta mucha atención a los comentarios en el código, pero es de muy buena práctica utilizarlos ya que pueden servir de referencia para otros programadores, inclusive, se puede obtener toda una documentación de las librerías si se siguen reglas estrictas a la hora de comentar,  ejemplos de reglas las podemos encontrar en los javadocs, phpdocs entre otros.

Convención de nomenclatura

Es bueno definir una buena guía a la hora de escribir nombres de archivos, clases, funciones, variables, constantes,  bases de datos, tablas y columnas, por ejemplo, en Java, el nombre de la clase debe coincidir con el nombre del archivo, haciendo fácil de esta manera ubicar cual es el archivo fuente para una clase.

Les sugiero que las constantes las definan todas en mayúsculas; que las variables globales tengan algún tipo de prefijo para que crear diferencias entre variables locales, en PHP por ejemplo, las variables súper globales empiezan con $_ haciendo así que sean fáciles de diferenciar; asegúrense que el nombre de las variables guarden algún tipo de relación con el tipo de información que se está almacenando,  por ejemplo, para almacenar el nombre de una persona, la variable se podría definir como $nombre y no llamarla simplemente $n , lo cual no nos brinda ningún tipo de descripción a simple vista.

Remover elementos innecesarios

Muchas veces uno escribe funciones para resolver operaciones complejas y de repente el alcance de la aplicación cambia haciendo que estas funciones queden obsoletas, pero el código es tan complejo que no vale la pena borrarlo dado que uno nunca sabe cuándo lo puede volver a utilizar y dejan el bloque de código comentado. En estos casos, lo ideal es tener un pequeño documento de texto en donde se irán almacenando todos estos códigos útiles, porque, recuerden, uno nunca sabe.

Esto es todo por ahora, mis amigos lectores y no olviden en dejar sus comentarios y/o sugerencias