Как я могу сослаться на параметр (тег @param) из другого параметра?

Question

Я использую Ruby on Rails 3.1.0 и гем YARD 0.7.4 для документации. Я бы хотел обратиться к параметру (тег @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