Débat qualité développement : Faut-il commenter son code source
Pour le rendre plus lisible et plus facile à maintenir ? Si oui comment ?

Le , par mayayu

0PARTAGES

1  0 
Faut-il commenter son code?
Dans le grand débat : Qu'est-ce qu'un code "propre" selon vous ?, tous le monde n'est pas d'accord sur le fait que commenter son code rende celui plus exploitable/lisible.

Quel est votre avis ?

Une erreur dans cette actualité ? Signalez-le nous !

Avatar de Pierre Fauconnier
Responsable Office & Excel https://www.developpez.com
Le 22/05/2009 à 21:53
Citation Envoyé par hegros Voir le message
.../...
Après un commentaire cela reste un commentaire après tout qui a vraiment le temps de tous les lire ?
.../...
Hum. C'est certain qu'avec ce genre d'arguments, le débat va avancer...!
1  0 
Avatar de Garulfo
Inactif https://www.developpez.com
Le 23/05/2009 à 2:53
Citation Envoyé par hegros Voir le message
Normal sur 500 000 lignes de code avec 30% de commentaire cela fait combien de livre à lire ? Je ne vois pas comment on pourrait tous les lire lorsque tu es sur n projets...
Aucun rapport. Tu n'écris pas un commentaire pour qu'un développeur les lise comme dans un livre. Encore une fois, tu ne comprends visiblement pas l'intérêt et le but d'un commentaire. Je te dirais bien de retourner un peu sur les bancs de l'école mais probablement que quelques réflexions et quelques bonnes lectures devraient suffire si tu fais un effort.
1  0 
Avatar de Félix Guillemot
Membre averti https://www.developpez.com
Le 09/06/2009 à 9:08
En voilà un débat passionnant, je suis tombé dessus grâce à la newsletter...
Je vais répondre comme il se doit !

J'ai commencé la programmation à 11 ans et j'en ai 36, avec 11 ans de missions dans des grandes boîtes. Mon expérience m'a conduit à écrire un livre, sûrement ressentant le besoin de faire un bilan de toutes ces années de code mais aussi de partager ce que je sais et qui pourrait, sans prétention, être utile à la communauté de mes confrères développeurs. Ce livre s'appelle "Le développement informatique durable". Vous trouverez une critique de Laurent Dardenne sur le site : http://conception.developpez.com/livres/?page=livresFR#L9782746222465

Ce livre défend de façon militante le développeur, souvent considéré injustement comme « l'ouvrier en bleu de travail de l'informatique », et il délivre ensuite certaines clés liées à la méthode qui doivent lui permettre d'accroitre de façon très significative ses performances.

Parmi ces clés, l'utilisation des commentaires à une place primordiale.
En effet, l'utilisation des commentaires n'a pas pour seul objectif de documenter le code pour nos successeurs ou encore nous même comme on nous le rabâche sans cesse : il doit permettre de donner une forme consciente à la pensée à l'état de fermentation consignées dans notre esprit.
Je m'explique avant qu'on croie que je viens de fumer le St Maclou de Velizy2 :
Pour réaliser ce que l'on pense et évaluer la pertinence de notre raisonnement, il est très utile, voire essentiel, de formaliser cette pensée, et la façon la plus efficace de le faire, hormis la parole est l'écriture.
Ainsi, les commentaires qui précéderont l'écriture de tout code vont "imprimer" notre pensée, et à la lecture de celle-ci, nous allons nous rendre compte des éventuelles lacunes de notre raisonnement pour le repenser, le reformuler et ainsi de suite jusqu'à arriver à une forme juste.

Lorsque ce raisonnement sera arrivé à maturité par l'aller-retour entre les pensées et l'écriture, nous procéderons à la seconde phase qui est l'écriture du code. Vous verrez alors avec quelle fluidité il se déroule puisqu'il n'est plus alors qu'une simple traduction syntaxique. Pour appliquer moi même cette méthode et l'avoir installée dans mon comportement de développeur, j'ai vu mes performances s'accroître d'une façon très significative : code écrit beaucoup plus vite, beaucoup moins de bugs, sérénité…

J'ai nommé cette méthode "l'écriture analytique".
Le chapitre qui lui succède se nomme "l'utilité des commentaires enfin révélée".

On ne peut pas dire que je viens juste faire de la pub pour un bouquin, je pense que ce débat était l'endroit idéal pour en parler.

Pour résumer mon avis, les commentaires sont INDISPENSABLES, d'abord parce qu'ils document le code mais surtout, et c'est là à mon sens la véritable utilité des commentaires, parce qu'ils permettent de structurer et murir notre raisonnement en le façonnant telle une sculpture pour donner ensuite une fluidité incroyable au code et des performances exceptionnelles, où du moins d'un niveau professionnel.

Une vidéo gratuite qui traite du sujet avec démo à l'appui est disponible sur developpez.com : http://delphi.developpez.tv/delphi2008/#session2
1  0 
Avatar de Garulfo
Inactif https://www.developpez.com
Le 19/05/2009 à 19:13
En fait ça ne se discute pas trop. La question n'est pas de savoir s'il faut commenter, mais plutôt comment et en quelle quantité. Il peut peut-être y avoir des cas extrêmement exceptionnel… menfinbon il me semble que même là les commentaires restent pertinents.
0  0 
Avatar de LittleBean
Membre averti https://www.developpez.com
Le 20/05/2009 à 11:05
pour moi oui mais avec modération ....

lors de cas de test bien tordu, issu du métier par exemple il est nécessaire d'avoir une petite note pour nous éclairer
0  0 
Avatar de white_tentacle
Membre émérite https://www.developpez.com
Le 20/05/2009 à 14:00
C'est un peu abuser ce sondage . Telle qu'est posée la question, je vois difficilement comment on peut répondre non.
0  0 
Avatar de hegros
Membre Expert https://www.developpez.com
Le 20/05/2009 à 14:15
Pour une démonstration/exemple/tutoriel/cours/etc oui il faut commenter le code c'est évident et vraiment utile.

En production par contre c'est différent. On ne peut plus appeler cela un commentaire puisqu'on s'en sert aussi pour l'automatisation des tests et/ou de la documentation voir d'autres choses encore.

Soit cela sonne comme 'complétement déréglée' lorsque chacun mets à sa sauce le type de commentaire qu'il lui fait plaisir et la qualité du document de code se dégrade avec le temps.

Qui n'a jamais lu un commentaire incompréhensible voir douteux sur un projet dans lequel il est entré et qui existe depuis belle lurette ? Tout le monde ? Alors il y a une immensité de code commenté qui ne serve à rien(probablement des pétagigaoctets)

J'ai donc répondu non.
0  0 
Avatar de mayayu
Membre régulier https://www.developpez.com
Le 20/05/2009 à 15:59
Citation Envoyé par white_tentacle Voir le message
C'est un peu abuser ce sondage . Telle qu'est posée la question, je vois difficilement comment on peut répondre non.
Je ne connais pas un seul sondage non orienté .
0  0 
Avatar de hegros
Membre Expert https://www.developpez.com
Le 20/05/2009 à 16:11
Citation Envoyé par emiaille Voir le message
Je ne connais pas un seul sondage non orienté .
Ce qu'il veut dire c'est que tu n'expliques pas ton sondage ni ne donne ton propre avis, juste un lien sur n pages discuté depuis n mois.

Et franchement répondre oui ou non à ce genre de question c'est effectivement un mauvais sondage
0  0 
Avatar de mayayu
Membre régulier https://www.developpez.com
Le 20/05/2009 à 16:14
Citation Envoyé par hegros Voir le message
Ce qu'il veut dire c'est que tu n'expliques pas ton sondage ni ne donne ton propre avis, juste un lien sur n pages discuté depuis n mois.

Et franchement répondre oui ou non à ce genre de question c'est effectivement un mauvais sondage
Mon avis est simple à déduire, tout le monde a répondu oui, sauf toi!

Je suis d'accord que la question est mal posée, mais hélas on ne peut pas la changer quand le sondage est lancé, il faudra vivre avec...
0  0 
Contacter le responsable de la rubrique ALM

Partenaire : Hébergement Web