ruby - Ruby Yard 是否具有可与 RDoc :include: 标记相媲美的功能？

Question

RDoc 具有 :include: 标记（参见本页底部），它将接收任意文本文件和格式，就好像它在包含开始的任何地方缩进一样。这是为文档示例提取源代码的好方法。

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 版本中。