Как мне предоставить документацию по YARD/RDoc для аргументов ключевого слова Ruby?

Для базового метода Ruby я бы предоставил документ типа YARD для параметров в следующем формате.

# @param query [String] The search string to query.
# @param options [Hash] Optional search preferences.
def search(query, options = {})
  # ...
end

С Ruby 2.0 теперь могут использоваться аргументы ключевых слов. Тем не менее, я не уверен, как подойти к этому с точки зрения документации YARD.

def search(query, exact_match: false, results_per_page: 10)
  # ...
end

Как я буду документировать для exact_match и results_per_page во втором сценарии? Должен ли я продолжать использовать ключевое слово @param или что-то лучше?

Ответы

Ответ 1

YARD распознает аргументы ключевого слова. Это должно работать:

# @param query [String] The search string
# @param exact_match [Boolean] whether to do an exact match
# @param results_per_page [Integer] number of results
def search(query, exact_match: false, results_per_page: 10)
  # ...
end