Cuándo usar comentarios

Clase 20 de 24 • Curso de Clean Code y Buenas Prácticas con JavaScript

Clase anteriorSiguiente clase

Elcira Ibarra

student•

El comentario no debe explicar:
- ❌ El ¿Qué? ⇒ porque el código debe ser Autodescriptivo
- ❌ El ¿Cómo? ⇒ el código debe ser Autoexplicativo
- ✅ Sino el ¿Por qué? // Comentar explicando los Criterios, aportando valor

“No comentes código mal escrito, reescríbelo.” Brian Kernighan

Si bien, al usar correctamente la nomenclatura, el ordenamiento de nuestras variables, funciones y clases y respetar el principio de responsabilidad única, va a hacer que nuestro código sea mucho más fácil de entender, no significa que se deba dejar de añadir comentarios. Por ejemplo, añadir un comentario sobre alguna librería externa que se haya utilizado.

Billy Torres

student•

🙌👌🏼

Jaime Eduardo Falla Cardozo

student•

Pienso que, a veces si son necesarios los comentarios para intentar explicar lógica de negocio que puede llegar a ser confusa y los comentarios pueden dar una idea de lo que hace. Por ejemplo, poner ejemplos en el comentario

Billy Torres

student•

cierto bro

Daniel Ochoa

student•

También sirve para acordamos que hicimos, pasan los meses y volvemos al código y ya no tenemos idea de lo que hicimos. en mi caso al principio de la clase siempre documento, colocando fecha. 22/04/2023 Agregue este método para actualizar la existencia en X tabla por ejemplo

Humberto Guardado

student•

"Yo comento lo que se me da la gana." Yo.

Reinaldo Mendoza

student•

Ojo con dejar todo's por ahi, ja

Jaime Eduardo Falla Cardozo

student•

Completamente de acuerdo

José Antonio Medina Sánchez

student•

Yo pienso que si mi código ya cumple con los principios solid o clean code, será poco necesario por que ya será autoexplicativo, al menos que requiera dar avisó del porque se utilizo alguna librería en particular como lo mencionan o porque se decidido hacerlo de una forma y no de otra. Saludos!!

Jose Ever Muñoz Muñoz

student•

Pienso que los comentarios son muy importantes al inicio cuando vas aprendiendo, a veces llegas a una solucion y cuando la lees una semana despues no logras entender como funciona del todo, la solucion es un comentario que te refresque la memoria.

Con el tiempo y la experiencia cada vez son menos necesarios, no obstante sigo pensando que pueden servirles a los nuevos empleados principiantes de la empresa.

Ademas existen los compiladores como Webpack que ya se encargan de quitar estos comentarios para produccion.

Markin Piero Pulache Guarniz

student•

buen aporte

Nayru Alexandra Ramirez Molano

student•

Jummm la cosa es saber hasta qué punto añadir comentarios

Edward Larsson Vega Carrillo

student•

Como hago para los TODO?

Reinaldo Mendoza

student•

resolverlos casi de una

Markin Piero Pulache Guarniz

student•

tampoco la tengo claro

Axel Enrique Galeed Gutierrez

student•

Creo que en estos casos es muy recomendable el uso de JSDoc o TSDoc, ya que va a ayudar a la experiencia de desarrollo y a tener una mejor lectura del código.

Jesus Adrian Camarena Cortez

student•

Creo que el código se debe de explicar en cosas muy importantes, o muy pesadas de entender.

Joan Alexander Valerio Rodríguez

student•

Dentro de la práctica, lo recomendable escribir comentarios para explicar usos o soluciones que le has dado a un código en especifico. Esto puede servir para entendimiento de un grupo de trabajo.

Maria Alejandra Luna Tito

student•

esta bien dejar TODOs o TECHDEBT?

Juan Diossa

student•

Pienso que si es importante, ya que aunque el código sea auto-descriptivo y auto-explicativo, no está de más dejar alguna nota que describa comportamientos y/o funcionalidades que permitan entender un bloque de código en un renglón de texto, ya que como se dice por ahí "pasas más tiempo leyendo código que escribiéndolo"

Cuándo usar comentarios

Introducción al Clean Code

Deuda técnica y refactorización de código

Reglas del diseño simple

Qué es Clean Code

Nombre y uso de las variables

Uso correcto de var, let y const

Reglas para la nomenclatura

Cómo nombrar según el tipo de dato

Nombres de Variables y Funciones Correctos en JavaScript

Ámbito de las variables

Ámbito global

Ámbito local o de función

Ámbito de bloque

Ámbito estático

Hoisting

Funciones

Declaración y expresión de funciones

Parámetros y argumentos

Funciones de flecha y el this

Clases

POO con ES6 (constructores, métodos y herencia)

Herencia en JavaScript

Tamaño reducido (responsabilidad única)

Organización

Optimizaciones

Cuándo usar comentarios

Formato coherente (codear en equipos)

Principio DRY

Tipos de Algoritmos y Complejidad Big O en JavaScript

Cierre

Sigue aprendiendo JavaScript