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

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

我应该继续使用@param关键字吗?

是的。

---

YARD识别关键字参数。使用@param以给定的名称、类型和可选描述记录单个方法参数(常规或keyword):

# @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

来源:YARD Tags @param at rubydoc.info