Quelle est la différence entre ri et rdoc
Question
Chaque fois que je je vois installer des gems suite ri et rdoc. Je sais que c'est la documentation, mais quelle est la différence entre les deux et comment les utiliser?
La solution
RDoc [..] est le générateur de documentation intégré pour le langage de programmation Ruby. [..] RDoc est inclus dans le cadre de la distribution de base Ruby.
RDoc fournit également le moteur pour créer des fichiers de données de Ruby. ri est (plus ou moins) la version de Ruby de pages de manuel, au service des informations API à partir de la ligne de commande.
Autres conseils
Pour accéder au RDoc local pour vos pierres précieuses, le type gem server
et pointez votre navigateur pour http://localhost:8808
.
Si les RDocs pour vos pierres précieuses ne sont pas installés, gem rdoc --all
will installer la documentation pour tous vos gemmes.
Il peut sembler la documentation locale n'est pas nécessaire. De nombreux développeurs sauter délibérément l'installer en faveur de la documentation en ligne. Cependant, pour ceux d'entre nous en utilisant des outils existants comme Rails 2, il peut permettre de trouver la bonne documentation rapide et facile.
-
RDoc
génère automatiquement la documentation des commentaires et structure de votre code. https://github.com/rdoc/rdoc Alors, pensez Doxygen. Utilisez-le pour générer de la documentation automatique pour le code que vous avez écrit. -
ri
est hors ligne les fichiers d'aide par exemple si vous ne disposez pas d'Internet. http://www.caliban.org/ruby/rubyguide.shtml#ri Pensezperldoc
. Utilisez-le lorsque vous avez une question sur une classe, commeri Enumerator
devrait faire apparaître
recenseur