Introduction

Les commentaires sont en fait très utiles en programmation s'ils sont bien placés. Mais la plupart du temps, les commentaires ne sont pas si "bons".

Les mauvais commentaires peuvent entraîner de la désinformation, une perte de temps, créer de mauvaises habitudes, etc.

Dans cet article, je vais vous expliquer comment éviter d'écrire de mauvais commentaires

Mauvais commentaires

Commentaires obsolètes

Les commentaires qui sont devenus obsolètes, obsolètes, non pertinents ou qui fournissent des informations erronées. Les commentaires peuvent vieillir très rapidement, car la base de code peut changer tous les jours, la technologie peut changer tous les jours.

Comment résoudre:

• Mettez-le à jour dès que possible
• Il suffit de le supprimer, en fait

Grammaire incorrecte, trop de marqueurs, marmonnement, plopping sont tout simplement mal écrits. Selon le code propre, un commentaire qui vaut la peine d'être écrit vaut la peine d'être bien écrit. Si vous allez en écrire un, prenez votre temps pour le peaufiner et choisissez vos mots avec soin.

Code commenté

C'est le pire genre de commentaires, ils me rendent fou chaque fois que je vois un morceau de code qui a été commenté. Ce code n'a rien fait, ils se sont assis là et ont pourri. Mais personne ne sait quand le supprimer car "peut-être que quelqu'un en aura besoin"

Comment le résoudre? Supprimez -le simplement ! De nos jours, Git est devenu très précieux, nous pouvons le trouver si quelqu'un en a vraiment besoin

Commentaires redondants

Ceux-ci sont terribles aussi, regardez ceci:

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}

Supprimez -les simplement .

Commentaires bruyants

Certains commentaires sont juste bruyants. Avez-vous déjà vu des commentaires comme ceux-ci?

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

Commentaires HTML

Rien à dire à ce sujet, je ne pense pas que les commentaires HTML soient utiles du tout. Nous avons un identifiant, un nom de classe, un nom de balise et mille autres façons de donner la signification d'un code. Pourquoi s'embêter à écrire des commentaires pour eux de toute façon ?

Conclusion

Bien que certains commentaires soient en fait nécessaires et bénéfiques, la plupart des commentaires ne le sont pas. Je sais que cet article n'est peut-être pas si positif, mais je veux juste justifier cela :

Si votre code est mauvais, ne le commentez pas, nettoyez-le simplement

Dans le prochain article, j'écrirai sur la façon d'écrire de bons commentaires, veuillez cliquer sur le bouton de suivi pour le vérifier à l'avenir.

Merci d'avoir lu

Derniers mots

Bien que mon contenu soit gratuit pour tout le monde, mais si vous trouvez cet article utile, vous pouvez m'acheter un café ici