IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Méthodes Agiles Discussion :

Un code sans commentaire [XP]


Sujet :

Méthodes Agiles

  1. #1
    Membre confirmé Avatar de ypicot
    Profil pro
    Inscrit en
    mai 2004
    Messages
    411
    Détails du profil
    Informations personnelles :
    Âge : 58
    Localisation : France

    Informations forums :
    Inscription : mai 2004
    Messages : 411
    Points : 576
    Points
    576
    Par défaut Un code sans commentaire
    Bonjour,

    Au cours d'une de mes promenades internetiennes, j'étais tombé sur un site ou forum qui défendait l'abscence de commentaire dans le code. Malheureusement j'en ai perdu le lien.

    Il ne s'agissait pas d'un site genre larache. La personne affirmait qu'on pouvait se passer de commentaire dans le code car :
    • les tests unitaires servent de doc interne
    • le code doit être auto-documenté (noms de variable et de classe clairs, taille des fonctions réduite, ...)
    • les commentaires sont rarement pertinents
    • si un bout de code astucieux a besoin d'être commenté, il n'a pas à être là (principe du "faire simple")
    • la doc générale (genre diagramme UML et autre CdC) est de toute façon à l'extèrieur du code (la personne insistait par ailleurs sur la nécessité d'une doc externe)
    • ... et j'en oublie...


    Est-ce que qqu'un aurait un lien vers un site défendant ces idées (qui sont à l'extrem de l'extrem programming) ?

    Et par ailleurs, qu'en pensez-vous ?

    Yvan
    boute-feu
    Une solution n'est valable que dans un contexte donné

  2. #2
    Rédacteur

    Avatar de Matthieu Brucher
    Profil pro
    Développeur HPC
    Inscrit en
    juillet 2005
    Messages
    9 810
    Détails du profil
    Informations personnelles :
    Âge : 40
    Localisation : France, Pyrénées Atlantiques (Aquitaine)

    Informations professionnelles :
    Activité : Développeur HPC
    Secteur : Industrie

    Informations forums :
    Inscription : juillet 2005
    Messages : 9 810
    Points : 20 967
    Points
    20 967
    Par défaut
    Tu peux regarder du côté de Kent Beck qui est assez partisan de cette idée. Je ne serai pas autant extrémiste, même si mon code est commenté comme indiqué dans ces conseils, j'ai besoin de faire des exposés pour l'expliquer aux gens qui voudraient le réutiliser.

  3. #3
    Membre confirmé Avatar de ypicot
    Profil pro
    Inscrit en
    mai 2004
    Messages
    411
    Détails du profil
    Informations personnelles :
    Âge : 58
    Localisation : France

    Informations forums :
    Inscription : mai 2004
    Messages : 411
    Points : 576
    Points
    576
    Par défaut
    Effectivement, ce genre d'attitude pourrait être signée par Papa XP.
    Mais j'ai cherché un peu partout (sur les Trois Rivières, google, ...) je n'ai pas trouvé de référence précise (ni de référence du tout d'ailleurs) à cette approche. Aurais-tu qque chose de plus précis dans tes bookmarks ?

    Par ailleurs, l'exposé est par nature "extérieur" au code, donc tu es dans ces clous-là

    Yvan
    Une solution n'est valable que dans un contexte donné

  4. #4
    Membre actif Avatar de TheoBenson
    Inscrit en
    août 2006
    Messages
    217
    Détails du profil
    Informations personnelles :
    Âge : 41

    Informations forums :
    Inscription : août 2006
    Messages : 217
    Points : 247
    Points
    247
    Par défaut
    salut,

    Pour ma part, je trouve que le commentaire aide dans le suivie d'un programme, surtous si ont travaille en groupe, afin qu'il y est plus de facilité a se rappelé ou comprendre certaine partie du code.

    cdt

  5. #5
    ego
    ego est déconnecté
    Rédacteur

    Homme Profil pro
    Architecte de système d'information
    Inscrit en
    juillet 2004
    Messages
    1 883
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 53
    Localisation : France, Hauts de Seine (Île de France)

    Informations professionnelles :
    Activité : Architecte de système d'information
    Secteur : Finance

    Informations forums :
    Inscription : juillet 2004
    Messages : 1 883
    Points : 3 501
    Points
    3 501
    Billets dans le blog
    2
    Par défaut
    J'ai trouvé ce site : http://www.literateprogramming.com/quotes_ad.html

    Pour ce qui est de mon avis perso, je suis assez d'avis pour ne pas commenter l'intérieur d'une opération. Celle-ci doit s'expliquer d'elle-même sinon c'est que le code est mal écrit. Par contre, mettre le nécessaire côté "JavaDoc" (ou autre en fonction du lanagage) pour savoir à quoi sert l'opération, là je suis plutôt pour.
    Lors de revues de code, le premier truc que je regardes c'est "est-ce que j'ai envie de lire ce code, comme j'aurai envie de lire un bon livre ?". Si la réponse est non, c'est en général mal parti !!

  6. #6
    Membre confirmé Avatar de ypicot
    Profil pro
    Inscrit en
    mai 2004
    Messages
    411
    Détails du profil
    Informations personnelles :
    Âge : 58
    Localisation : France

    Informations forums :
    Inscription : mai 2004
    Messages : 411
    Points : 576
    Points
    576
    Par défaut
    Merci, Ego, c'est tout à fait ce que je cherchais (plus exactement, je l'ai trouvé via un lien dans la page que tu as donné).

    Pour la doc, je suis à 80% d'accord avec toi : peu/pas dans le code, davantage dans les entêtes. Par contre, je n'ai jamais réussis à considérer la doc comme un bon livre

    Méthodologiquement,

    Yvan
    Une solution n'est valable que dans un contexte donné

  7. #7
    ego
    ego est déconnecté
    Rédacteur

    Homme Profil pro
    Architecte de système d'information
    Inscrit en
    juillet 2004
    Messages
    1 883
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 53
    Localisation : France, Hauts de Seine (Île de France)

    Informations professionnelles :
    Activité : Architecte de système d'information
    Secteur : Finance

    Informations forums :
    Inscription : juillet 2004
    Messages : 1 883
    Points : 3 501
    Points
    3 501
    Billets dans le blog
    2
    Par défaut
    Tu n'as peut être jamais rencontré de codeur qui avait l'âme d'un écrivain

+ Répondre à la discussion
Cette discussion est résolue.

Discussions similaires

  1. code sans commentaire
    Par davidee dans le forum C++Builder
    Réponses: 4
    Dernier message: 07/01/2008, 11h50
  2. Difficulté avec un code sans algo
    Par panda31 dans le forum Algorithmes et structures de données
    Réponses: 10
    Dernier message: 07/04/2006, 10h43
  3. Profiler du code...sans profiler :s
    Par progfou dans le forum C
    Réponses: 2
    Dernier message: 29/03/2006, 09h48
  4. [Mail] exit du code sans sortir du html...
    Par sam01 dans le forum Langage
    Réponses: 4
    Dernier message: 02/03/2006, 00h04
  5. Réponses: 3
    Dernier message: 27/01/2006, 16h48

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo