Existe-t-il une bonne référence solide pour une syntaxe RDoc correcte?

Question

Je cherche une bonne référence solide pour une syntaxe RDoc correcte. Recommandations? Je ne peux pas sembler trouver tout ce qui montre clairement:

1. Comment documenter les méthodes de classe et leurs paramètres
2. Comment documenter ce qu'est une méthode de classe ou de classe ne.

Answer 1

Mise à jour lien mort dernière documentation rdoc se trouve ici https://ruby.github.io/rdoc/ExampleRDoc_rdoc.html

La documentation à rdoc.rubyforge.org semble être plus complète que la version à rdoc.sourceforge.net (qui a d'ailleurs une date modifiée 2003).

En outre, il existe une grande source d'exemples: la documentation Ruby core et stdlib. Par exemple, jetez un oeil à l'une des méthodes de classe du File class:

File.atime (nom_fichier) => temps

Renvoie la dernière fois d'accès pour le fichier nommé comme temps objet).

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

Vous pouvez voir le code source d'origine, y compris le balisage RDoc, en cliquant sur la première ligne (dans la page RDoc réelle, pas dans la citation que j'inclus dans cette réponse). Dans ce cas, la méthode a été mise en œuvre en C, mais la mise en forme RDoc est le même que si elle a été mise en œuvre en Ruby:

/* 
* call-seq: 
*  File.atime(file_name) => time 
* 
* Returns the last access time for the named file as a Time object). 
*  
*  File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003 
*  
*/ 

De cela, vous pouvez voir que call-seq: vous permet de remplacer le nom de la méthode et des paramètres avec le texte de votre choix, ce qui est très utile pour les méthodes de classe. Il montre également comment vous pouvez afficher un exemple de code dans une police à espacement fixe en l'indentant, similaire à Markdown.

Answer 2

Depuis RubyForge has been retired, voici un nouveau lien:

http://ruby-doc.org/gems/docs/r/rdoc-4.1.1/RDoc/Markup.html