ドキュメント修飾子に関する簡単な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