26

基本的な 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

2 番目のシナリオでは、どのように文書化しexact_matchますか? このキーワードresults_per_pageを使い続けるべきですか、それとももっと良いものがありますか?@param

4

1 に答える 1