如何從另一個參數引用參數（'@參數'標籤）？

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