ruby - 如何用 YARD 记录一个不返回任何内容的方法

Question

我有这样的方法

def self.import(file_name, opts = {})

我正在尝试用 YARD 记录下来。然而，这是一种 100% 副作用的方法(我知道，我知道，副作用，呃!)。但是对于此方法的用户，实际上没有任何类型的返回对象，但是 YARD 生成如下签名:

+ (Object) import(file_name, opts = {})

有什么办法可以告诉 yard import 方法什么都不返回吗？

我可以告诉它返回 nil，但这不是一回事

Answer 1

所有方法都会返回一些东西，void 关键字可能就是您要查找的内容。

# @return [void]
def method_returning_unknown_object
end