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

Question

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

是否Yard有类似的标签或功能吗？

Answer 1

目前 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 版本中得到跟踪和添加。