Einfache rdoc Frage zum Dokumentation Modifikatoren

Question

Ich habe diese Methode in einer Klasse verwende ich

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

und ich möchte in der Dokumentation für die Parameter erscheinen als def binary_search(array, key) und nicht binary_search(a,x). Ich habe versucht, die Dokumentation Modifikator # :binary_search: array, key ohne Erfolg zu nutzen. Ich weiß, das eine kleine Sache, aber wenn jemand weiß, wie man die Parameter in der Dokumentation nicht machen zu tun, als in der eigentlichen Quellcode, können Sie zeigen mir bitte? Danke.

Answer 1

Sie sollen die :call-seq: zu verwenden, um der Lage sein, Richtlinie im Kommentar Methode Header wie folgt:

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

Das habe ich noch nicht bekommen zu arbeiten. Ich verwende RDoc V1.0.1 und Ruby 1.8.7.

Answer 2

Vielleicht # :args: thing_to_try versuchen etwa so: (über Leerzeichen vorsichtig sein)

# 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