考慮下面的ruby文件，foo.rb： # this is a module comment
module A
# this is a constant comment
B = 'hi'
# this is a class comment
class C
# this is a method comment
# @param [Stri
我有一個不純的功能，像這樣： # Impure function: Sets the status for a report_schedule, uses last_sent to
# calculate status
# @param report_schedule [Hash]
# @return [String] Non-useful: value of last_sent that
我有一個看起來像這樣的方法： def get_endpoint(params: {})
end
我想這個方法的調用者能在幾個可選的參數傳遞。 我想寫YARD文檔來支持這個，如果我沒有使用關鍵字參數，我會使用@option聲明。 然而，YARD自己的文檔說： Note: For keyword parameters, use @param, not @option. 所以，我想： # @par
當試圖創建我的圍欄控制器的文檔和使用的參數時，由於圍場似乎期待，參數作爲方法參數存在，所以我陷入困境。 # Renders a list of items
# @param params [Hash] the search parameters
# @option params [String] 'info' Only return items with this specific info