[RDoc] Paramètres de retour d'une fonction et exemple de code

Juste un petit post pour donner 2 astuces pour améliorer sa rdoc (alias ruby doc).

Comment faire une jolie rdoc comme celle de Enumerable par exemple:

Le code:

 # call-seq:
 #     class.new_method(string)                    => array
 #
 # Description.
 #     MyClass.new.new_method("hello")         #=> [1, 2, 3]
 def new_method(str)
   ...
 end

Deux points à remarquer:

• Le call-seq (+ 1 ligne vide) pour désigner le type d'objet retourné et les paramètres
• les 5 espaces (whitespace) devant l'exemple d'utilisation pour le faire apparaitre sous forme de code. (rem: <tt>code</tt> marche aussi)

Technorati tags: rdoc ruby