YARD 用于具有默认哈希值的关键字参数

Question

我有一个看起来像这样的方法：

def get_endpoint(params: {})
end

我希望这个方法的调用者能够传入一些可选参数。

我想编写 YARD 文档来支持这一点，如果我不使用关键字参数，我将使用@option声明。

但是，YARD 自己的文档说：

注意：对于关键字参数，使用@param，而不是@option。

所以我试过：

  # @param params [Hash] options to be used in request
  # @param date [String] date in YYYYMMDD
  # @param start_time [Integer] start_time in Epoch

这失败了，因为 YARD 只能看到我正在使用的params关键字参数。 确切的失败是：

@param tag has unknown parameter name: date

然后我尝试使用@option语法替换为param关键字：

  # @param params [Hash] options to be used in request
  # @param params [String] :date in YYYYMMDD
  # @param params [Integer] :start_time in Epoch

这会导致不同的错误：

@param tag has duplicate parameter name: params

理想情况下，我想用此方法的用户可以使用的 3 或 4 个选项来描述params哈希。 有没有办法做到这一点？

Answer 1

该签名不使用:date或:start_time关键字参数。 这些参数的关键字参数将被指定为：

def get_endpoint(date:, start_time:)

@option专门用于指定将包含在您的案例params的 options Hash中的选项。 由于您对params使用关键字参数，因此我建议为此添加@param标签，以清楚地识别关键字参数。 例如：

@param params [Hash]  options to be used in request
@option params [String] :date in YYYYMMDD
@option params [Integer] :start_time in Epoch

@options文档以防万一。