Vamos a ver 5 consejos prácticos de programación que te ayudarán a que tu código sea mucho mejor, más legible y fácil de entender, y así hacerle la vida un poco más fácil a nuestro equipo. 😁
Antes de entrar en materia… ¿por qué es importante aplicar buenas practicas al programar?
La mayoría de nosotros empezamos en este sector en nuestras casas de forma autodidacta o siguiendo una formación reglada y comenzamos a picar nuestras primeras línea de código únicamente para nosotros o para que sean corregidas, por tanto… «qué más da si es más o menos bonito si es mío y para mi».
Pero cuando empezamos a programar a nivel profesional normalmente trabajaremos en equipos de desarrollo y ya no estaremos solos, por tanto tenemos que intentar seguir unos estándares y buenas prácticas por varios motivos, primero de todo para que tú mismo entiendas tu propio código dentro de un mes y segundo para que tus compañeros también lo entiendan, por que recuerda ya no estás solo en tu cueva de programador!
Aquí te vamos a dar un par de tips y ejemplos (todos los ejemplos expuestos serán en lenguaje javascript) con el objetivo de mejorar en la calidad de tu código y que tu yo del futuro y tus compañeros te odien un poco menos… Como guinda, al final del artículo también te dejamos algunas herramientas para comprobar la calidad del código. 😎
¡Empezamos!
Para que quede doblemente claro: ¿Qué pasa si no aplicamos estos consejos? 🤔
Si no los aplicamos cada vez que adaptamos el proyecto en base a las necesidades de los usuarios, será mucho más difícil seguir añadiendo funcionalidades y mejoras tanto para nosotros mismos como para nuestros compañeros actuales y futuros.
5 buenas prácticas para que escribas mejor código
Consejo 1: usa la sangría
La sangría la utilizamos para recolocar correctamente el código utilizando indexaciones (espacios) en las líneas de código, para que su lectura a primera vista sea mucho más amena. En lenguajes como Python es completamente obligatorio utilizarlas, porque si no el código no funciona, sin embargo en lenguajes como javascript, c# u otros no lo es.
En la siguiente imagen podemos ver un código con varias sentencias IF condicionantes y sus ELSE correspondientes, pero sin ningún tipo de sangría aplicada, lo cual dificulta muchísimo entender las lógicas aplicadas en él.
A continuación, podéis ver la misma parte de código pero con este consejo aplicado, el cual se lee muchísimo más fácil y ayuda a comprender los conjuntos de condicionantes mejor.
Consejo 2: Variables descriptivas
En este caso una imagen vale más que mil palabras, intentemos entender que vemos en este código.
Sois capaces de saber que contienen las variables varGen. Var1, 2 y 3? No verdad. ¿Y ahora?
Las variables que podemos ver en la primera imagen de este consejo no describen en ningún momento para qué las vamos a utilizar. Todo lo contrario a la segunda imagen en la cual sí podemos:
- Ver para qué las hemos creado.
- Qué almacenamos en ellas.
- Para qué las queremos utilizar en un futuro.
No es lo mismo guardar un valor Fecha: 05/03/2023 en una variable llamada “var1” que en una variable llamada “date”.
Consejo 3: Evita la repetición de código 🔁
Esta práctica es más habitual de lo que imaginamos. Lógicamente el ejemplo que vamos a mostrar aquí es muy simple e identificable pero en otros casos nos costará un poco más.
¿Veis alguna parte de código repetida?
Sí, las dos funciones que hemos mostrado necesitan siempre, antes de realizar su acción, consultar el estado de la base de datos, pero no necesitamos repetir este código tantas veces como se necesite.
Lo que se debe realizar es una función común donde unificar ese código repetido y utilizarla donde haga falta.
Vamos a mostrar el código mejorado:
Consejo 4: Comenta tu código brevemente
Una acción muy sencilla para mejorar el entendimiento del código del proyecto es añadir comentarios breves en el inicio de las funciones para saber que parámetros recibirá esa función, que va a retornar, si es que lo hace, y que lógica aplica en su interior.
En esta imagen podemos ver un ejemplo de lo que NO es brevemente:
No te vuelvas loco añadiendo comentarios en el código 🤯. Podemos ayudar al equipo añadiendo pequeños comentarios explicando la funcionalidad del método, pero no hace falta que lo expliquemos absolutamente todo, en este caso yo haría lo siguiente:
Os voy a contar un secreto: si es en inglés, mejor. Llegaréis a mucha más gente.
Consejo 5: Prueba
Como último punto y no menos importante, probar vuestro código todo lo que podáis y más. Tenéis a vuestra disposición varias herramientas y técnicas que os pueden ayudar a ello.
Tenemos diferentes tipos de pruebas:
- Pruebas Funcionales: verifica funciones mediante la emulación de escenarios de negocio, en función de los requisitos funcionales.
- Pruebas de Integración: asegura que los componentes o funciones del software operen juntos.
- Pruebas unitarias: valida que cada unidad de software funcione según lo esperado. Una unidad es el componente de prueba más pequeño de una aplicación.
- Pruebas de estrés: prueba cuánta tensión puede soportar el sistema antes de que falle. Considerado como un tipo de prueba no funcional.
Pueden parecer muy simples o podemos pensar que ninguno de nosotros caeríamos en aplicar de forma incorrecta alguno de estos consejos que hemos mencionado, pero es mucho más común de lo que pensamos.
Analizadores de calidad de código 👀
Existen herramientas que nos ayudan en el reto de tener un código limpio y mantenible como:
- Sonarqube: es la herramienta de análisis de seguridad y calidad de código más popular del mercado. Con el apoyo de la comunidad de código abierto, Sonarqube actualmente puede analizar y producir resultados para más de 25 lenguajes de programación.
- PMD: es un analizador de código fuente estático de código abierto que informa sobre los problemas encontrados dentro del código fuente de una aplicación.1 PMD incluye conjuntos de reglas incorporados por defecto y admite la capacidad de escribir reglas personalizadas. No informa errores de compilación, ya que solamente puede procesar archivos fuente bien formados. Es capaz de analizar archivos escritos en los lenguajes Java, JavaScript, Apex y Visualforce, PLSQL, Apache Velocity, XML y XSL.
- CheckStyle: es una extensión para los IDE de análisis de código estático que se utiliza en el desarrollo de software para comprobar si el código fuente de Java cumple con las reglas de codificación.
En resumen, estos 5 consejos de programación para escribir código a parte de ayudar a todo el equipo de un proyecto concreto y crear un buen producto a prueba de bomba, fundamentalmente son positivas para tu desarrollo como programador y para ser un poquito mejor cada día.
Santander Digital Services es una compañía del Grupo Santander con más de 7.000 empleados y basada en Madrid. Trabajamos para convertir al Santander en un banco digital con sucursales.
Mira las posiciones que tenemos abiertas aquí para unirte a este equipazo y Be Tech! with Santander 🚀
Síguenos en LinkedIn y en Instagram.
Raquel Rodríguez
Santander Digital Services
Full Stack Developer y curiosa por las tecnologías desde pequeña. He conseguido dedicarme a ello y además, compartir mis conocimientos con toda la gente que sea posible.
Mi perfil de LinkedIn: https://www.linkedin.com/in/raquel-rodr%C3%ADguez-gonz%C3%A1lez-3619a093/
