Introducción

Los comentarios son realmente muy útiles en la programación si están bien ubicados. Pero la mayoría de las veces los comentarios no son tan “buenos”.

Los malos comentarios pueden generar desinformación, pérdida de tiempo, crear malos hábitos, etc.

En este artículo, te guiaré sobre cómo evitar escribir malos comentarios.

malos comentarios

comentarios desactualizados

Comentarios que se han vuelto viejos, obsoletos, irrelevantes o proporcionan información incorrecta. Los comentarios pueden envejecer muy rápidamente, porque el código base puede cambiar todos los días, la tecnología puede cambiar todos los días.

Cómo resolver:

• Actualízalo lo antes posible
• Solo bórralo, en realidad

Gramática incorrecta, demasiados marcadores, murmullos, plopping están mal escritos. De acuerdo con el código limpio, vale la pena escribir bien un comentario que vale la pena escribir. Si vas a escribir uno, tómate tu tiempo para pulirlo y elige tus palabras con cuidado.

Código comentado

Este es el peor tipo de comentarios, me vuelven loco cada vez que veo un fragmento de código comentado. Ese código no hizo nada, se sentaron allí y se pudrieron. Pero nadie sabe cuándo borrarlo porque “tal vez alguien lo necesite”

¿Cómo resolverlo? ¡Solo bórralo ! Hoy en día Git se ha vuelto muy valioso, podemos encontrarlo si alguien realmente lo necesita

Comentarios redundantes

Estos también son terribles, mira esto:

for(let i = 0; i < 10; i++){
  a = b // assign a to b
}

// a function returns sum of a and b
function sum(a, b){ return a + b}

Solo bórralos .

comentarios ruidosos

Algunos comentarios son simplemente ruidosos. ¿Alguna vez has visto comentarios como estos?

// the name
private String name
// the version
private String version
// the constructor
constructor()

//The 123213 License
//
//Copyright (c)123213213213213, and Contributors
//
//Permission to use, copy, modify, and/or distribute this software for any
//purpose with or without fee is hereby granted, provided that the above
//copyright notice and this permission notice appear in all copies.
//
//THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
//WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
//MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
//ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
//WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
//ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
//IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Comentarios HTML

No hay mucho que decir sobre esto, no creo que los comentarios HTML sean útiles en absoluto. Tenemos ID, nombre de clase, nombre de etiqueta y mil formas más de saber el significado de un código. ¿Por qué molestarse en escribir comentarios para ellos de todos modos?

Conclusión

Aunque algunos comentarios son realmente necesarios y beneficiosos, la mayoría de los comentarios no lo son. Sé que este artículo tal vez no sea tan positivo, pero solo quiero justificar eso:

Si su código es malo, no lo comente, solo límpielo.

En el próximo artículo escribiré sobre cómo escribir buenos comentarios, presione el botón Seguir para comprobarlo en el futuro.

Gracias por leer

Ultimas palabras

Aunque mi contenido es gratuito para todos, pero si encuentra útil este artículo, puede invitarme a un café aquí.