Простой Rdoc Вопрос о модификаторах документации

Question

У меня есть этот метод в классе, который я использую

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

, и я хочу, чтобы в документации параметры отображались как def binary_search(array, key) а не binary_search(a,x).Я попытался использовать модификатор документации # :binary_search: array, key безуспешно.Я знаю это немного, но если кто-то знает, как сделать параметры, отличающиеся в документации, от фактического исходного кода, не могли бы вы показать мне?Спасибо.

Answer 1

Может быть, попробуйте # :args: thing_to_try примерно так: (будьте осторожны с пробелами)

# 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

Answer 2

Вы должны иметь возможность использовать директиву :call-seq: в комментарии заголовка метода следующим образом:

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

У меня еще не получилось. Я использую RDoc V1.0.1 и Ruby 1.8.7.