Question

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

  1. Comment les méthodes de classe de documents et de leurs paramètres
  2. Comment documenter ce qu'est une méthode de classe ou de classe fait.
Était-ce utile?

La solution

Un exemple officiel de rdoc se trouve , avec son GitHub la source .

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 y a une grande source d'exemples: le noyau Ruby et de la documentation stdlib. Par exemple, jetez un oeil à l'une des méthodes de classe de la classe File :

  

File.atime (file_name) => temps

     

Renvoie la dernière fois d'accès au   fichier nommé comme un objet Time).

     

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

Vous pouvez afficher 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 a également montre comment vous pouvez afficher un exemple de code dans une police monospaced par indenter il, semblable à Markdown.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top