Présence de commentaires dans les sources

Tout ce qui concerne le développement d'Actionaz.
Post Reply
niconil
Posts: 93
Joined: 12 Mar 2012, 10:11

Présence de commentaires dans les sources

Post by niconil »

Aujourd'hui, je peux intervenir sur un pb ponctuel, mais je n'ai pas encore de vision d'ensemble des sources et des classes, j'avoue que l'absence de commentaires est parfois très frustrante, et je dois faire un effort pour comprendre les liens entre objets et le rôle des méthodes.

C'est un choix délibéré ?
Puis-je en introduire un peu dans mes contributions futures ?

Quelle est la position du gardien du repository ? (joli titre non :wink: )

User avatar
Jmgr
Admin
Posts: 1640
Joined: 07 Dec 2005, 15:45
Contact:

Re: Présence de commentaires dans les sources

Post by Jmgr »

En fait j'ai été traumatisé par la Javadoc et les commentaires inutiles du genre "//Contructor" ou int setX(int x) // Sets the value of x (tu peux aussi voir le code source de AutoHotKey pour un bon exemple de commentaires qui rendent le code source illisible : http://www.autohotkey.com/)
Du coup je préfère donner des noms explicites à mes classes et méthodes, même si ça implique d'avoir des noms longs (n'importe quel IDE supporte l'auto-complétion).
Je commente assez peu, trop peu sans doute, mais je le fais normalement au endroits où l'algorithme ou la logique me semble pas très évidente.
Je pense qu'il manque une vision générale de l'architecture du code, c'est à dire une description des différents "modules" et leur utilité. Je pense ajouter ça à l'occasion, en attendant n'hésite pas à poster des listes de questions si quelque chose n'est pas clair.

N'hésite pas à commenter ton code, tant que c'est pas de la Javadoc ça me va :p
"My software never has bugs. It just develops random features."

Post Reply