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

Question

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

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

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

Answer 1

Вы должны быть в состоянии использовать :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.

Answer 2

Может быть, попробуй # :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