Ruby Yard是否具有与RDoc相当的功能:include:tag?

时间:2010-12-21 16:39:05

标签: ruby rdoc yard

RDoc具有:include:标签(请参阅this page的底部),它将接收任意文本文件和格式,就像它在包含开始的地方缩进一样。这是为文档示例提供源代码的好方法。

Yard是否有类似的标记或功能?

1 个答案:

答案 0 :(得分:3)

目前,YARD仅支持以下列形式嵌入来自其他对象文档字符串的文档:

class Foo
  # Docstring here
  def method; end

  # Here is some more docs and {include:Foo#method}
  def bar; end
end

文件包含的计划含糊不清,但之前从未真正提出要求,因此不是高优先级。如果您想在http://github.com/lsegal/yard/issues上打开问题,我们可以确保在即将发布的0.7.0版本中对其进行跟踪和添加。