ruby-on-rails - 如何从另一个参数引用参数 ('@param' 标签)？

Question

我正在使用 Ruby on Rails 3.1.0 和 YARD 0.7.4 gem 用于文档目的。我想引用一个参数(@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

这可能吗？如果可以，我该怎么做？

Answer 1

十年后，似乎仍然没有办法引用另一个参数，我认为这是有道理的，因为默认的 html 文档没有参数的 anchor (如果你看到@rene-saarsoo 对其他答案的评论想使用 anchor )，但你可以让它看起来更好一些。

使用 <code>paramName</code>标签来应用样式，如果参数在正在记录的方法中，我认为这就是所有需要完成的。示例:

# Adds <code>a</code> and <code>b</code>.
#
# @param a [Integer] a number that will be added to <code>b</code>
# @param b [Integer] a number that will be added to <code>a</code>
def add(a, b)
  a + b
end

上面的例子在生成的网页上是这样的:

如果您正在引用另一个方法的参数，您可以使用 object link在<code>旁边标签。