Question

对于基本的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关键字，还是有更好的东西？

Answer 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

我应该如何为Ruby关键字参数提供YARD / RDoc文档？

1 个答案: