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

标签 ruby documentation yard

我有这样的方法

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

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

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

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

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

最佳答案

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

# @return [void]
def method_returning_unknown_object
end

void return rendering

关于ruby - 如何用 YARD 记录一个不返回任何内容的方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25715454/

相关文章:

ruby - 我可以继续使用 MongoDB v2.2.0rc 使用 1.6.4 Ruby 驱动程序吗?

ruby - 在整个目录上执行 Ruby 脚本

Ruby Imap OpenSSL::SSL::SSLError:读取服务器证书 B:证书验证失败

ruby - 使用 rakefile 从源代码生成文档

Ruby Yard 文档 : preformatted code

ruby - 从 Ruby 中的类方法调用私有(private)实例方法

c++ - 如何使用 Doxygen 记录 C++ 函数中的局部变量

html - 自动保存属性应该做什么?我该如何使用它?

internationalization - wsdl 是否为 :documentation tag support the xml:lang attribute?

ruby - 使用 YARD 记录模型属性