如何从另一个参数引用参数（'@param' 标记）？答案

【问题标题】：How can I refer to a parameter ('@param' tag) from another parameter?如何从另一个参数引用参数（'@param' 标记）？
【发布时间】：2012-01-21 02:31:08
【问题描述】：

我将 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

有可能吗？如果是这样，我该怎么做？

【问题讨论】：

@ALL - 没有人记录他/她的申请？（！）

标签： ruby-on-rails ruby documentation reference yard

【解决方案1】：

我对 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

【讨论】：

那么，有没有“真正”的理由“尝试”完成我想做的事情（重新阅读问题以获取更多信息）？
我认为这通常是不值得的。但是如果你真的需要它，那么我想你可以创建一个 HTML 锚点 <a name="your-param"></a> 标记并使用 HTML 链接链接到它。