Drama Tech: ¿Los comentarios son mala práctica?

Y ahí vamos de nuevo un nuevo drama tech ha nacido en la comunidad de tecnología de este tema, ya habrás visto bastante y hasta puede que sea un tema del pasado, pero vamos a comentarlo.

Este nuevo tema es parte de la siguiente pregunta, colocar comentario en el código es buena o mala práctica, este dicho por qué el código debería ser legible y descriptible. Como siempre esto siempre va a depender mucho del punto de vista de cada desarrollador y desarrolladora, si no, no existiría este drama. Después de leer y escuchar de diversas opiniones en el medio

Desde que aprendí siempre se me dijo que debo escribir código legible, código para que otro desarrollador puedo leerle y continuar con lo que dejemos, al mismo tiempo que los comentarios sirven para ayudar a comprender este código.

Recuerdo cuando llegué a un proyecto, este afortunadamente tenía la estructura que conocía y esto me ayudó a comprender qué estaban haciendo, pero era una enredadera para buscar todo, no sabía que hacía cada componente o dónde podían usarse, me tocaba leer todo el código, ir archivo por archivo buscando que hace cada cosa, la pérdida de tiempo era muy evidente, lo único que me ayudó era la estructura de carpetas y archivos de proyecto.

Pero si vamos a tener, por ejemplo, componente de frontend, como pueden ser los de React, tener una pequeña documentación en el archivo, me hubiera ayudado a comprender que, hacia ese componente en específico, o si estaba en uno de los tantos duplicados que había.

Otro ejemplo, de cuando llegó a código de una app que escribir y que tuve que dejar en pausa, en el que la verdad no me recordaba al 100% todo el proyecto, pero después de ver la estructura y que mi código afortunadamente era legible y con eso es que puedo retomar sin tener tanta complicación. ¿Te preguntarás si dejo comentarios? Y sí, afortunadamente mi código era legible y no tuve problemas, en algunos casos no fue necesario regresar a los comentarios, pero en otros casos más complejos me sirvieron como una guía para saber qué hace cierto archivo.

¿Por qué no tener ambas?

Veo conveniente tener ambas y esto es porque tener una función o una variable demasiado descriptiva también en mi caso me arruina la legibilidad del código, por ejemplo:

estaEsUnaFuncionQueExtraeContenidoATravesDeScraping = () => {}

Bueno, igual y no algo tan exagerado, pero puede que no sea lo mejor tener todo el código así y mejor tener un comentario más legible que nos diga esto para qué sirve cada argumento o cuál es el funcionamiento y cómo se relaciona con otros servicios o archivos es que puede ser muy útil tener comentarios como documentación, y si agregamos un buen código legible, esto para leer va a ser maravilloso.

¿Qué no puede faltar?

En mi opinión, lo que no puede faltar a la hora de escribir código es escribir código legible, o lo más legible que se pueda que los nombres que asignemos tengan significado que tenga una estructura base, como es en el Backend tener todo en su respectiva capa. Esto va a facilitar mucho el trabajo a la hora de leerlo y usarlo.

Mientras que los comentarios, si bien pueden no estar cuando tenemos lo primero es que estos nos pueden servir como guía

Tu proyecto actual

Tal vez el proyecto donde te encuentres trabajando te restrinjan el escribir comentarios, o nombrar variables o funciones bajo el estándar que se haya elegido y bueno, ahí nos toca adaptarnos, esperemos que esta decisión haya sido la mejor para que todo el equipo trabaje en la misma sintonía, pero quedarse con una sola mentalidad donde no puedas mejorar en los procesos para escribir código es que ya no estoy de acuerdo y es por lo que te decía que la mentalidad importaba, si eres más abierto vas a probar y experimentar y puede que arruines algunas cosas, o por el otro lado que por experiencia pienses que no hay otra mejor manera de hacer las cosas.

Ambos extremos están mal en mi opinión, creo que con lo que te escribí es que apoyo que el código sea legible, pero que los comentarios pueden ayudar muchísimo, tampoco es que sea es mejor desarrollador de la historia, pero esto me ha ayudado muchísimo, pero me gustaría leerte qué es lo que tú opinas y cuál sería tu metodología para tener un mejor código, así podemos seguir aprendiendo con el conocimiento de todos 😊


Cursos de Hola Mundo para aprender a programar

Te dejaremos el enlace a todos nuestros cursos de programación, los cuales los encontrarás disponibles en la academia Hola Mundo y puedes optar por adquirir los cursos de manera individual en el siguiente link: todos los cursos de Hola Mundo, si prefieres acceso a todo, también puedes elegir un plan de suscripción mensual o anual, y además te invitamos al siguiente enlace donde vas a poder obtener un descuento en tu primer año a sólo $49.90 usando el cupón PRIMERA_VEZ al momento de realizar tu pago

acceso a todo primer año

O igualmente puedes optar por cada curso de manera individual en Udemy.

Bibilioteca de Hola Mundo para aprender a programar

Portada Ultimate Python

Pero si tu tipo de aprendizaje se adapta mucho mejor a los libros, igualmente puedes acceder a nuestros títulos para aprender a programar y así armar tu propia biblioteca.

Podras adquirir este material en Amazon Amazon en su versión física y en su versión digital, donde también puedes ver un fragmento en esta misma página de Amazon para que así puedas consultar su contenido.


Y esto ha sido todo de este post, si te ha encantado, ¡golpea al botón de me gusta!, dejanos un comentario, y para no perderte nada, no olvides suscribirte a este blog, seguirnos en todas las redes como Youtube, Twitter, Instagram y Tiktok, y por último, te invitamos a escuchar nuestra música «Hola Beats«, diseñada para ayudarte a concentrarte y acompañarte en tu aprendizaje o trabajo, la puedes encontrar en Spotify, Apple Music, Amazon Music, Youtube Music y Deezer.

¡Hasta la próxima!, y chao mundo

Gabriel Hernández

Soy desarrollador fullstack autodidacta y estudié administración en la universidad. Mi stack es principalmente con JavaScript, haciendo frontend con React y Next, y backend con Node y Express. Otras herramientas con las que he trabajado son Python para backend y Solidity para desarrollo de contratos inteligentes.

Deja un comentario

Press ESC to close

Descubre más desde Hola Mundo

Suscríbete ahora para seguir leyendo y obtener acceso al archivo completo.

Seguir leyendo