如何YARD记录一个什么都不返回的方法

时间:2014-09-07 22:49:51

标签: ruby documentation yard

我有这样的方法

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

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

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

有没有办法告诉院子导入方法什么都不返回?

我可以告诉它返回nil,但那不是一回事

1 个答案:

答案 0 :(得分:7)

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

# @return [void]
def method_returning_unknown_object
end

void return rendering