Question simple RDoc sur les modificateurs de documentation

Question

J'ai cette méthode dans une classe que je utilise

def binary_search(a,x)
  # ...
end

et je veux dans la documentation pour les paramètres apparaissent comme def binary_search(array, key) et non binary_search(a,x). Je l'ai essayé d'utiliser le modificateur de documentation # :binary_search: array, key sans succès. Je sais que ce une petite chose, mais si quelqu'un sait comment faire faire les différents paramètres dans la documentation que dans le code source, pouvez-vous me montrer? Merci.

Answer 1

Vous êtes censé être en mesure d'utiliser le :call-seq: directive dans l'en-tête méthode commentaire comme suit:

##
# Pass array and key.
#
# :call-seq:
#   binary_search(array, key)
def binary_search(a, x)
  # ...
end

Je n'ai pas encore ce travail. J'utilise V1.0.1 RDoc et Ruby 1.8.7.

Answer 2

Peut-être essayer # :args: thing_to_try comme ceci: (attention des espaces)

# rdoc-2.5.8/lib/rdoc/parser/ruby.rb:48
# The parser extracts the arguments from the method definition.  You can
# override this with a custom argument definition using the :args: directive:

   ##
   # This method tries over and over until it is tired 

   def go_go_go(thing_to_try, tries = 10) # :args: thing_to_try
     puts thing_to_try
     go_go_go thing_to_try, tries - 1
   end