Commenter son code…

Cela semble être une chose plus compliquée que d’apprendre un nouveau langage de programmation (pour certains en tout cas)…
Les commentaires font parti du code source (oui ma petite dame), sans lui et malgré toutes les spécifications du monde, un code source peut vraiment être obscur: Mauvais noms de variables, classes ou encore design patterns exotiques faits maison… Mais là où cela devient vraiment obscur, c’est quand on tombe sur un commentaire qui enfonce le clou encore plus, du style « //TODO : Refactor… ». OK… euh bon là j’avais bien compris que moi je n’aurais pas codé le bouzin comme çà, et même le gars qui l’a codé le savait lui aussi. Merci de m’avertir avec un beau TODO mais en fait il ne sert à rien car ton code là, et bien je vais le refactorer mais en plus je vais imaginer et espérer qu’il faisait ce que je vais en faire avec mes 10 doigts et mon reste de cerveau (car non ami développeur, je n’en ai surement pas plus que toi).

C’était la pensée du jour : « Coder c’est bien, avec les commentaires intelligents c’est mieux »

Une réflexion sur “Commenter son code…

  1. Je suis entièrement d’accord avec ce point🙂

    Mais malheureusement, de trop nombreux développeurs, sous de fortes contraintes extérieures omettent de faire des commentaires intelligents.

    Souvent les commentaires sur les setters / getters sont affligeants, puisqu’ils ne répondent pas aux questions suivantes :
    – quelles sont les valeurs acceptées par ce champ (ainsi que les éventuels controles effectués par les getters / setters)
    – puis-je mettre / recevoir un null (merci Java 7 pour le coup du null safe invocation)
    – quel type d’exception suis-je susceptible de rencontrer et pourquoi
    – …

    La plupart de ces remarques sont valables pour la plupart des méthodes en fait🙂

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s