Yard如何记录返回返回yield块类型的Ruby方法?

时间:2019-11-07 11:27:33

标签: ruby yard

我有一个方法,可以选择使用一个块。

它要么返回将提供给缺席块的参数数组,要么透明地返回yield的结果。

我知道我可以使用@overload来不同地处理阻塞/无阻塞原因,但是我怎么能说@return的block子句就是阻塞给我的东西呢?如果这是Kotlin,我将使用类型参数with_build_parameters(...)或其他类型。

# @overload with_build_parameters
#   @return [Array] if no block is given
# @overload with_build_parameters(&block)
#   @yieldparam [Hash<String, String>] config_props
#   @yieldparam [Hash<String, String>] build_props
#   @yieldreturn [T] whatever you like
#   @return [T] whatever the block said

我主要是想让它与RubyMine的类型检查一起使用。

0 个答案:

没有答案