Semplice rdoc Domanda sul modificatori di documentazione

Question

Ho questo metodo in una classe che sto usando

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

e voglio nella documentazione per i parametri di apparire come def binary_search(array, key) e non binary_search(a,x). Ho cercato di utilizzare il modificatore di # :binary_search: array, key documentazione senza successo. So che questo una piccola cosa, ma se qualcuno sa come fare rendere i diversi parametri nella documentazione che nel codice sorgente, potete per favore mostrarmi? Grazie.

Answer 1

Si suppone di essere in grado di utilizzare la :call-seq: direttiva nel metodo di intestazione commento come segue:

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

Non ho ancora questo lavoro. Sto usando RDoc V1.0.1 e Ruby 1.8.7.

Answer 2

Forse provare # :args: thing_to_try in questo modo: (attenzione su spazi bianchi)

# 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