La importancia de tener un código limpio

Para todo buen desarrollador la importancia de tener un código limpio es fundamental, no solo por la estética del mismo sino por la rápida localización de los distintos elementos (variables, funciones, clases, métodos, etc…) que forman nuestro proyecto.

Para conseguir este propósito podemos seguir algunos principios básicos que nos ayudarán a mantener nuestro código limpio y que sea fácil de entender tanto para nosotros, en el futuro cuando tengas que modificar algo y no nos acordemos para que sirve esta función, como para cualquiera que tenga que leer nuestro código:

1) Mantener la correcta indentación de los elementos.

El código que hagamos debe de ser claro y fácil de interpretar tanto por nosotros como por cualquiera, nunca se sabe si dentro de algún tiempo vas a tener que modificar ese código que dejaste tan enrevesado y ahora ni tu mismo lo entiendes.

Un claro ejemplo de un código enrevesado es el siguiente:

    $cantidad1 = 3; $cantidad2= 5; if( $cantidad1 + $cantidad2 > 8){ echo "El resultado es mayor de 8"; }else{ echo "El resultado es menor de 8"; }

Esta claro que aunque es muy simple el código es molesto de ver y podríamos arreglarlo aplicando una simple indentación:

$cantidad1 = 3;
$cantidad2 = 5; 

if( $cantidad1 + $cantidad2 > 8 ){
    echo "El resultado es mayor de 8";
}else{
    echo "El resultado es menor de 8";
}

Con lo que quedaría mucho mas claro y sencillo de ver lo que hace de un simple vistazo.

2) Ponerle nombres correctos a los distintos elementos.

Mientras que estamos programando estamos continuamente creando/usando variables o funciones con un nombre que nosotros entendemos pero hemos de pensar que tenemos que poner un nombre descriptivo a cada cosa dependiendo para lo que sirvan.

No es lo mismo poner esto:

function zfq($a,$b){
    return $a+$b;
}

$asd = 3;
$qwe = 5; 

if( zfq($asd , $qwe) > 8 ){
    echo "El resultado es mayor de 8";
}else{
    echo "El resultado es menor de 8";
}

Aquí no se entiende nada y los nombres tanto de las variables como de la función son incorrectos.

Sería mejor algo así de simple:

function suma($sumando1,$sumando2){
    return $sumando1+$sumando2;
}

$cantidad1 = 3;
$cantidad2 = 5; 

if( sumar($cantidad1, $cantidad2) > 8 ){
    echo "El resultado es mayor de 8";
}else{
    echo "El resultado es menor de 8";
}

Así queda mucho mas claro y se entiende lo que hace cada cosa.

3) Cada cosa en su sitio.

El orden en el que ponemos los distintos elementos de nuestro código es fundamental a la hora de la funcionalidad pero también es bueno respetar un orden cuando estamos hablando de tener un código limpio y ordenado en nuestro archivo

Si tenemos este archivo de la siguiente forma:

function suma($sumando1,$sumando2){
    return $sumando1+$sumando2;
}

$factor1 = 7;
$factor2 = 5;

$cantidadASumar1 = 4;
$cantidadASumar2 = 8;

function resta($minuendo,$sustraendo){
    return $minuendo-$sustraendo;
}

echo "El resultado de la suma es". suma($cantidadASumar1, $cantidadASumar2);

function multiplicacion($factor1,$factor2){
    return $factor1*$factor2;
}

$minuendo = 10;
$sustraendo = 5;

echo "El resultado de la resta es". resta($minuendo, $sustraendo);
echo "El resultado de la multiplicación es". multiplicacion($factor1, $factor2);

Como ven este código no tiene ni pies ni cabeza y se arreglaría ordenándolo fácilmente de la siguiente forma:

function suma($sumando1,$sumando2){
    return $sumando1+$sumando2;
}

function resta($minuendo,$sustraendo){
    return $minuendo-$sustraendo;
}

function multiplicacion($factor1,$factor2){
    return $factor1*$factor2;
}

$cantidadASumar1 = 4;
$cantidadASumar2 = 8;
$minuendo = 10;
$sustraendo = 5;
$factor1 = 7;
$factor2 = 5;

echo "El resultado de la suma es". suma($cantidadASumar1, $cantidadASumar2);
echo "El resultado de la resta es". resta($minuendo, $sustraendo);
echo "El resultado de la multiplicación es". multiplicacion($factor1, $factor2);

Poniendo primero las funciones, luego las variables y después el resultado nos queda el código mucho mas ordenado y sencillo

4) Comentar el código.

Una de las cosas que mas se agradece cuando estamos viendo un código es que el que lo haya hecho se haya tomado su tiempo para comentarlo, describiendo que hace cada función/parte de código para que sea fácil entender que hace a simple vista.

Por ello es bueno que mientras que vamos formando nuestro código vayamos comentando lo que hace para que en un futuro nos sea mas fácil identificar para que sirve cada cosa.

/*A esta función se le pasan 2 números y te devuelve la suma de ellos*/
function suma($sumando1,$sumando2){
    return $sumando1+$sumando2;
}

/*A esta función se le pasan 2 números y te devuelve la resta de ellos*/
function resta($minuendo,$sustraendo){
    return $minuendo-$sustraendo;
}

/*A esta función se le pasan 2 números y te devuelve la multiplicación de ellos*/
function multiplicacion($factor1,$factor2){
    return $factor1*$factor2;
}

/*Cantidades para las operaciones*/
$cantidadASumar1 = 4;
$cantidadASumar2 = 8;
$minuendo = 10;
$sustraendo = 5;
$factor1 = 7;
$factor2 = 5;

/*Mostramos los resultados de nuestras operaciones*/
echo "El resultado de la suma es". suma($cantidadASumar1, $cantidadASumar2);
echo "El resultado de la resta es". resta($minuendo, $sustraendo);
echo "El resultado de la multiplicación es". multiplicacion($factor1, $factor2);

Y estos son 4 sencillos pasos que puedes usar en tu programación diaria y que te facilitaran la labor de programar tanto a ti como a cualquiera que vea tu código.

Suscríbete a nuestro Newsletter

Introduce tu mail

Recibirás un mail con una URL para confirmar la suscripción (Chequea tu bandeja de Spam)
Mantenimiento y Soporte

Verificar el estado de un Ticket

Por favor introduzca su email y su número de ticket, y le enviaremos un link de acceso.



Si es la primera vez que contacta con nosotros o perdio el número del ticket, por favor Abra un nuevo Ticket.