jeudi 21 août
April | Agenda du libre | Framasoft | Léa-Linux | Lolix | JeSuisLibre | Eyrolles | LinuxMag | Veni, Vidi, Libri | InLibroVeritas | LinuxGraphic
Faire un don ! | | style | statistiques | contactez-nous | plan | lettre d'information
Accueil :: Dépêches :: Archives :: Proposer une dépêche :: Journaux :: Forums :: Entretiens :: Suivi :: RDF

Journal : çà sert a rien les commentaires

Posté par kassoulet (Jabber id, page perso, ) le 26 mars 2004
pour nourrir le troll (http://linuxfr.org/~jcs/10947.html(...)), j'expose mon point de vue:

Les commentaires çàpueçàsertarien !
pourquoi ? parce qu'on ajoute des commentaires si le code n'est pas clair! dans ce cas il faudrait mieux clarifier le code non ?

changer le nom des fonction/variables, decouper en plus de fonction pour decouper le code...

** plutot que:
// faire un truc
[...]
// faire un autre truc
[...]

**
faireUnTruc();
faireUnAutreTruc();

** plutot que:

for(i=0;i<1024;i++) {}

**
for( numeroDeFace=0; numeroDeFaces<nombreDeFaces; numeroDeFaces++ ) {}


des commentaires sur un code crade çà ne rend pas le code propre !

ps: bien sur il faut documenter dans les entetes, les fonctions et leurs parametres, et ne pas hesiter a expliquer un algo...

> Lire le journal (34 commentaires, moyenne: 1,9).  

Vous avez demandé le commentaire #379819.

Re: çà sert a rien les commentaires

Posté par Boa Treize (page perso, ) le 26/03/2004 à 17:02. (lien). Évalué à 2.

Les commentaires, ça sert à expliquer le pourquoi, pas le comment. Aucun code source ne te permettra de comprendre le pourquoi. (Et puis de temps en temps, quand tu ponds du code de sioux, un petit comment ne peut pas faire de mal, pour le mec moins doué que toi qui viendra essayer de corriger un bug plus tard.)

  • [^]Re: çà sert a rien les commentaires

    Posté par Pinaraf (Jabber id, ) le 26/03/2004 à 17:06. (lien). Évalué à 0.

    Quoi ?
    Il y a encore des programmeurs qui créent des bugs ???

    • [^]Re: çà sert a rien les commentaires

      Posté par fred point (page perso, ) le 26/03/2004 à 18:50. (lien). Évalué à 1.

      Celui qui ne fait rien, ne fait pas d'erreur...

      • [^]Re: çà sert a rien les commentaires

        Posté par plagiats () le 27/03/2004 à 09:22. (lien). Évalué à 1.

        encore faut il bien le faire
        un programme sans bug, c'est un hello world en java par Pierre Tramo.

        --
        La mort est un phénomène naturel qui se produit par l'avalement répété de petites quantités de salive au cours d'une grande période de temps. - George Carlin

    [^]Re: çà sert a rien les commentaires

    Posté par #3588 () le 26/03/2004 à 17:12. (lien). Évalué à 1.

    Faut lire... c'est exactement ce qu'il dit : les commentaires -> en en-tête des fonctions, modules, etc. mais pas au sein du code.

    [^]Re: çà sert a rien les commentaires

    Posté par Guinns (page perso, ) le 26/03/2004 à 17:29. (lien). Évalué à 2.

    Je plussoierais .. si je pouvais ...
    En effet, le commentaires ne sont pas la pour décrire ce que l'on fait mais pourquoi on le fait ...

    Imagine un algo qui contrôle la validité d'une date; dans le cas des années non bissextiles, on va refuser les 29 février, ton code sera donc du type

    /* on refuse le 29/02 si on n'est pas bissextile */
    SI (annee NON bissextile ET jour>28 ET mois==2 )
    ALORS retourne ERROR;

    Et bien dans ce cas, le commentaire explique le "pourquoi métier".
    Pour cet exemple, tout le monde sait que seules les années bissextiles possèdent un 29/02, mais dans une appli métier, tu ne peux présupposer des connaissances métier des futurs codeurs, d'où une explication nécessaire dans le commentaire.

    • [^]Re: çà sert a rien les commentaires

      Posté par manuel () le 26/03/2004 à 17:43. (lien). Évalué à 1.

      /* on refuse le 29/02 si on n'est pas bissextile */
      SI (annee NON bissextile ET jour>28 ET mois==2 )
      ALORS retourne ERROR;

      Bref, on dit en français ce que fait le code. Ca permet de lire les sources rapidement en ne lisant que les commentaires.
      Pour moi c'est un commentaire "QUOI". Il en faut, et je trouve qu'ils rendent le code plus agréable à lire.

      Les commentaires "POURQUOI et COMMENT" ont à mon avis plus leur place dans des grosses cartouches en tête de fichier ou de fonction.

      • [^]Re: çà sert a rien les commentaires

        Posté par jemore () le 26/03/2004 à 18:08. (lien). Évalué à 2.

        SI (est_bissextile(jour, mois, annee)) ALORS retourne ERROR;

        se passe de commentaire...

        --
        Les dalles brillantes c'est pourri

        • [^]Re: çà sert a rien les commentaires

          Posté par manuel () le 26/03/2004 à 18:39. (lien). Évalué à 2.

          C'est domage, vu que c'est un code incompréhensible.

          C'est une erreur si ta fonction renvoie une valeur non nulle quand on lui passe 29, 2 et 2004 ?

          • [^]Re: çà sert a rien les commentaires

            Posté par #3588 () le 26/03/2004 à 21:02. (lien). Évalué à 1.

            « C'est domage, vu que c'est un code incompréhensible. »

            Non. Tout ce qu'il y a à savoir sera dans l'entete de la fonction qui contient ça.

Run by Team LinuxFr.org

Cette page a été générée par Templeet en 0.0576s (dont 0.0053 de SQL).
Cette page est peut-être conforme xhtml 1.0.
Information sur le site.