Discussion :

[ypicot]

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

[Matthieu Brucher]

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.

[ypicot]

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

[TheoBenson]

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

[ego]

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 !!

[ypicot]

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

[ego]

Tu n'as peut être jamais rencontré de codeur qui avait l'âme d'un écrivain