La documentation de l'API de Ruby et Ruby On Rails à la sauce PHP.net !
Par Bounga le jeudi, 18 mai 2006, 18:25 - Les liens indispensables - Lien permanent
Il est facile avec Ruby de commenter son code et d'en tirer une documentation bien utile quand on est développeur voire même utilisateur final. Le seul souci est que la documentation générée n'est pas superbement bien organisée, on ne peut pas effectuer de recherches ni d'autres actions un peu avancées. C'est là qu'intervient l'auteur de l'application Rannotate écrite en Rails et qui génére de la documentation Ruby.
On a donc grâce à cela une documentation bien organisée, avec des possibilités de recherches, d'ajout de notes par les utilisateurs. Pour ceux qui connaissent, cette application a été conçue en prenant exemple sur ce qui est fait du côté de la documentation de PHP.
Si vous commentez votre code Ruby[1] vous pouvez donc facilement utiliser cette application pour créer un site qui gère votre documentation, qui laisse vos utilisateurs poster des commentaires, faire des recherches, etc.
C'est déjà une bonne nouvelle n'est-ce pas ? Mais la vrai bonne nouvelle est que l'auteur de cette application a pris soin de mettre en ligne la documentation de l'API Ruby et Ruby On Rails dans ce format.
Vous trouverez la documentation de l'API Ruby à l'adresse http://ruby.outertrack.com et celle de l'API Ruby On Rails sur http://rails.outertrack.com.
Voilà qui va faciliter la vie à tous les développeurs Ruby et RoR :-).
Notes
[1] au format RDoc