RDoc - RDoc

RDoc
Auteur (s) original (s)	Dave Thomas
Version stable	5.1.0 / 24 février 2017 ; il y a 3 ans
Dépôt
Écrit en	Rubis
Système opérateur	Multiplateforme
Type	générateur de documentation embarqué
Licence	GPLv2
Site Internet	ruby .github .io / rdoc /

RDoc , conçu par Dave Thomas , est un générateur de documentation intégré pour le langage de programmation Ruby . Il analyse le code source Ruby , générant une collection structurée de pages pour les objets et méthodes Ruby . Les commentaires de code peuvent être ajoutés dans un style naturel. RDoc fait partie de la distribution principale de Ruby. Le logiciel et le format RDoc succèdent au format Ruby Document (avec le logiciel RD associé).

RDoc peut produire une documentation utilisable même si le code source cible ne contient pas de commentaires explicites car il analysera toujours les classes , modules et méthodes, et les listera dans les fichiers API générés . RDoc fournit également le moteur de création de fichiers de données Ruby ri, permettant d'accéder aux informations d'API à partir de la ligne de commande .

RDoc et ri sont actuellement maintenus par Eric Hodel et Ryan Davis .

Syntaxe

RDoc prend en charge quatre langages de balisage, RDoc Markup, Markdown , tomdoc et rdtool. Son propre balisage RDoc est utilisé par défaut. Dans RDoc Markup, les directives spéciales sont placées entre deux points. Par exemple, pour indiquer qu'une méthode prend des arguments appelés siteet article, on peut écrire :args: site, article.