ruby - 我应该如何为 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

Should I just continue to use the @param keyword?

是的。

---

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

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