introduzione

I commenti sono in realtà molto utili nella programmazione se sono ben posizionati. Ma la maggior parte delle volte i commenti non sono così "buoni".

I commenti negativi possono portare a disinformazione, perdita di tempo, creare cattive abitudini, ecc.

In questo articolo, ti guiderò su come evitare di scrivere commenti negativi

Commenti negativi

Commenti scaduti

Commenti che sono diventati vecchi, obsoleti, irrilevanti o forniscono informazioni errate. I commenti possono invecchiare molto rapidamente, perché la base di codice può cambiare ogni giorno, la tecnologia può cambiare ogni giorno.

Come risolvere:

• Aggiornalo il prima possibile
• Basta eliminarlo, in realtà

Grammatica errata, troppi marcatori, borbottii, plopping sono solo scritti male. Secondo il codice pulito, vale la pena scrivere bene un commento che vale la pena scrivere. Se hai intenzione di scriverne uno, prenditi il ​​tuo tempo per rifinirlo e scegli attentamente le parole.

Codice commentato

Questo è il peggior tipo di commenti, mi fanno impazzire ogni volta che vedo un pezzo di codice che è stato commentato. Quel codice non ha fatto nulla, si sono seduti lì e sono marciti. Ma nessuno sa quando cancellarlo perché “forse qualcuno ne avrà bisogno”

Come risolverlo? Basta cancellarlo ! Al giorno d'oggi Git è diventato molto prezioso, possiamo trovarlo se qualcuno ne ha davvero bisogno

Commenti ridondanti

Anche questi sono terribili, guarda questo:

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}

Basta eliminarli .

Commenti rumorosi

Alcuni commenti sono solo rumorosi. Avete mai visto commenti come questi?

// 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.

Commenti HTML

Non c'è molto da dire su questo, non credo che i commenti HTML siano affatto utili. Abbiamo ID, nome della classe, nome del tag e mille altri modi per dire il significato di un codice. Perché preoccuparsi di scrivere commenti per loro comunque?

Conclusione

Sebbene alcuni commenti siano effettivamente necessari e utili, la maggior parte dei commenti non lo è. So che questo articolo potrebbe non essere così positivo, ma voglio solo giustificarlo:

Se il tuo codice è errato, non commentarlo, puliscilo e basta

Nel prossimo articolo scriverò su come scrivere buoni commenti, premi il pulsante Segui per verificarlo in futuro.

Grazie per aver letto

Ultime parole

Sebbene i miei contenuti siano gratuiti per tutti, ma se trovi utile questo articolo, puoi offrirmi un caffè qui