Programmation.autre : Commentaires dans le code
Posté par Jonas813 () le 28 septembre 2008
1
Bonjour
J'aimerais savoir combien de commentaires vous mettez quand vous coder.
Mon prof d'informatique nous obligeait à mettre un commentaire par ligne de code et nous disait qu'on devrait être capable de recréer le code s'il ne restait plus que les commentaires.
C'est sûrement un peu exagéré, un commentaire tous les 5-6 lignes devraient suffire à mon avis.
En visionnant une partie des codes sources de certains programmes, je remarque qu'on est loin de ça. Je trouve que c'est quand même dommage, car plus de commentaires aiderait celui qui aimerait contribuer à un programme, créer un patch par exemple.
> Lire le message (16 commentaires, moyenne: 4,2).
Vous avez demandé le commentaire #968585.
Run by 
Cette page a été générée par Templeet en 0.0475s (dont 0.0036 de SQL).
Cette page est peut-être conforme xhtml 1.0.
Information sur le site.
Faire un don !
Moi même
Moi, je ne commente que l'entête des fonctions de la façon suivante :
- Ce que doit faire la fonction
- Les paramêtres non triviaux,
- La valeur de retour.
- Et les conditions d'utilisations (base de données ouvertes, structures) pour que la fonction s'exécute bien.
Éventuellement, je rajoute les exceptions qui risquent d'être levées.
Commenter le code à l'intérieure de la fonction, c'est nul. Parce que :
1) lors de mise à jour du code, les commentaires n'ont pas d'obligation à être remis à jour. dans la réalité, ils ne le sont pas.
2) C'est le signe d'une mauvaise conception.
3) c'est chiant à faire.
voilà pour moi.
http://linuxfr.org/board <-- des moules, du sang, de la violence
[ Répondre ]
[^]Re: Moi même
Pareil.
Avec tout de même des commentaires dans le corps des fonctions quand on se retrouve avec des manipulations obscures des données, genre
((call/cc ((lambda (x) (set! foo x) (bar x))) #\w))) ;; alloue 3 octets supplémentaires
Parfois même, je commente avec une version naive mais claire de l'algo.
J'aime la liberté.
J'aime BSD.
[ Répondre ]