如何从另一个参数引用参数（'@参数'标签）？

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

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