Bonjour � tous,

Aujourd'hui j'apporte une question non pas technique mais pratique.

Habituellement, je documente mon code avec Doxygen. J'ai cette habitude et je tiens � faire la documentation pour tout les projets que je r�alise (m�me les persos, o� il n'y a que moi pour lire le code)

Dans la th�orie, Doxygen nous force � documenter toutes les fonctions que l'on va cr�er. Personnellement, j'aime bien avoir des getter dans mon code (c'est essentiel, m�me), et la documentation des getters est vraiment r�barbative.
De plus, si une classe Sprite � une m�thode draw(), comment puis je documenter correctement cette fonction, sachant que son nom indique ce qu'elle fait ?

Je pose la question, car je viens de lire ceci:
Citation Envoy� par 3DArchi
Sur les commentaires et la documentation : toute ligne doit apporter une information qui n'est pas d�j� fournie par ailleurs. Par expl, inutile de commenter ce qui est �vident � la lecture du code. Ou ne pas produire de documentation qui soit l'exact reflet du code. Chacun doit avoir son niveau pertinent d'information.
Alors que dois je faire pour ma fonction draw()? Je vais la documenter du genre:
"Dessinne mon sprite".
(Logique, elle s'appelle draw() la fonction, elle ne va pas traire une vache )

Donc, ma question est: Que dois je faire dans ces cas l� ?
Sachant que �crire la documentation prend du temps et si doit document� plein de getter, je vais vite �tre ennuy� (et donc, bien souvent, ne plus �tre efficace / faire du copier-coller ). De plus, j'aimerai que ma documentation soit claire (�videmment).

Merci pour vos futurs conseils