Le 25/02/10 17:45, Julien Lestavel a écrit : > Salut à tous, > > Je vous sollicite pour un petit partage d'expérience concernant la > documentation du code (commentaires ou documents annexes). Avez-vous des > bonnes pratiques à recommander? > > Pour être plus précis, j'aimerais instaurer des pratiques un peu plus > rigoureuses sur le sujet au sein de notre équipe de développement, afin > d'obtenir un code bien documenté et, chose importante, de manière > homogène (que les commentaires aient tous le même formalisme). Avez-vous > des conseils à ce sujet? > > Les questions que je me pose sont : > - que documentez-vous? (tous les fichiers? toutes les méthodes?) > - comment documentez-vous? (avez-vous un modèle de commentaire? quelles > informations gardez vous : auteur, date de dernière modif, description? > utilisez-vous rdoc?...) > > Je sais que Ruby a l'avantage d'être très intuitif, donc de nécessiter > moins de commentaires explicatifs, mais je pense qu'il ne nous en > dispense pas complétement... > > Merci d'avance pour vos réponses!
Personnellement ma meilleur documentation s'appelle Rspec ou Cucumber 1. m'oblige a tester mon code 2. Me liste facilement les fonctionnalités de mon code Au niveau du code pur. J'avoue ne pas trop documenté. En effet, documenter les méthodes du controller sont souvent inutile. Le vrai truc a document est le code de librairie. Dans les ressources que je peux te proposer, c'est un post de yannick http://elsif.fr/le-code-et-les-commentaires -- Cyril Mougel http://blog.shingara.fr/ -- Vous avez reçu ce message, car vous êtes abonné au groupe "Railsfrance" de Google Groups. Pour transmettre des messages à ce groupe, envoyez un e-mail à l'adresse [email protected] Pour résilier votre abonnement envoyez un e-mail à l'adresse [email protected]
