aucun commentaire ou alors une petite explication si vraiment, mais alors vraiment, la methode le necessite
Le code doit etre assez explicite pour être comprehensible par un autre développeur qui le lit pour la premiere fois. Et quand il y a un commentaire surtout pas d'humour ou de commentaire à la "cool". Alexis On Feb 26, 8:35 pm, Michel Belleville <[email protected]> wrote: > Mes 2 cents : > > 1. commencer par de très bons tests qui montrent bien ce que devrait > faire le bidule, pas trop commentés > 2. continuer avec une bonne grosse description dans le README ; elle > devrait idéalement couvrir toute l'API dans ce qu'elle a de général, > laisser > les particularités ailleurs > 3. pour chaque classe centrale, un petit pavé de description spécifique > dans son fichier pour expliquer comment elle marche > 4. donner une ligne de description minimum pour chaque méthode à exposer > dans l'api, quand son nom ne rend pas son fonctionnement évident ; si les > paramètres ne sont pas évidents, les expliquer > 5. utiliser :nodoc: pour les méthodes dont le comportement est évident / > hérité (ex: si une classe inclue Enumerable et qu'elle redéfinie quand même > each pour qu'il fasse ce que l'on s'attend qu'il fasse, hop un petit > :nodoc: > pour éviter qu'elle n'encombre la doc inutilement, on n'est pas en Java) > 6. de temps en temps un commentaire peut clarifier un code obscure dans > une méthode, mais depuis que je code du Ruby j'ai rarement été dans une > situation où c'était vraiment le cas (ou alors c'était un script de 1000+ > lignes qui de toute façon mériterait d'être correctement factorisé / > classifié) > > De toute façon, il n'y a pas vraiment de ligne directrice stricte, donc le > mieux c'est quand même une logique qui te convient et que tu suis. > > Michel Belleville > > 2010/2/25 Francois Stephany <[email protected]> > > > > > Nicolas Jacobeus (de Belighted) a fait une courte présentation de quelques > > bonnes pratiques Rails au FOSDEM 2010. > > > Rien de bien nouveau pour les développeurs confirmés mais ça peut faire du > > bien aux débutants/gens qui codent tout seul: > > >http://www.slideshare.net/Belighted/25-real-life-tips-in-ruby-on-rail... > > > -- > > Francois Stephany > >http://agilitic.com > > > -- > > 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] -- 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]
