RDOC具有:inclage:tag(请参阅底部 这一页),这将采用任意文本文件和格式,就好像在任何范围内开头一样被缩进。这是提取文档示例源代码的好方法。

院子 有类似的标签或功能?

有帮助吗?

解决方案

当前,院子仅支持以形式的其他对象docstrings嵌入文档:

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

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top