文档使用YARD实例方法的返回类型返回类的实例

时间:2016-06-03 10:36:28

标签: ruby documentation yard

我无法在Yard的文档中找到它。

我希望记录实例方法的返回类型。例如,

class Foo
  def initialize
  end
end

我将其记录为

@return [???] returns the instance of `Foo`

我应该写什么?它应该是Foo吗?

1 个答案:

答案 0 :(得分:2)

正确,按照tags overview提及以下内容:

  

班级或单元类型

     

允许任何Ruby类型作为类或模块类型。这种类型只是类或模块的名称。