4

ドキュメントの目的で、Ruby onRails3.1.0とYARD0.7.4gemを使用しています。別のパラメータからパラメータ（タグ）を参照したいのですが。つまり、私は持っています：@param

# ...
#
# @param [String] argument_1
#   Here I would like to have a description text with a reference/link to the
#   'argument_2' parameter (see below)...
#
#   Maybe here I can use something like '@param', '{}' or '@macro'... but, how?
#
# @param [String] argument_2
#   Some description text...
#
def method_name(argument_1, argument_2)
  ...
end

出来ますか？もしそうなら、どうすればそれを作ることができますか？

4

1 に答える 1

-3

YARDについてはよくわかりませんが、使用したドキュメントツールでそのような機能を提供したものはありません。これは、本当に必要になることはめったにないからだと思います。

代わりに、パラメーターの名前を指定するだけで、参照しているパラメーターがコンテキストから明らかである必要があります。

# True when number is between given min and max values.
# @param [Number] min
# Must be smaller or equal to max.
# @param [Number] max
# Must be larger or equal to min.
def between?(min, max)
  min <= self && self <= max
end
于 2012-01-20T18:31:08.177 に答える