【发布时间】：2014-09-07 22:49:51
【问题描述】：
我有这样的方法
def self.import(file_name, opts = {})
我正试图用 YARD 记录它。然而，这是一种 100% 副作用的方法（我知道，我知道，副作用，呃！）。但是对于这种方法的用户来说，实际上没有任何类型的返回对象，但是 YARD 会生成这样的签名：
+ (Object) import(file_name, opts = {})
有没有办法告诉 yard 导入方法什么都不返回？
我可以告诉它返回 nil，但这不是一回事
【问题讨论】：
-
方法应该公开吗？这似乎是一种“副作用”，只有其他方法可能会调用它，因此它不需要是公共方法......
-
由于 Ruby 方法通常返回最新表达式的返回值，所以我对你的方法的样子很感兴趣。
-
是的，这个方法应该是公共的，因为它是一个类的唯一用户可访问的入口点（ruby 从一个容器程序中运行，这个类将用户指定的数据导入到该程序中）
-
@spickermann - 该方法实际上返回 nil ...但我希望文档表明该方法不是用于返回值（而是用于执行副作用）
标签： ruby documentation yard