院子里，如何将图像包含到文档中？

【问题标题】：yard, How to include image to documentation?院子里，如何将图像包含到文档中？
【发布时间】：2011-05-08 15:35:31
【问题描述】：

我想在码生成的文档中包含图像，但在任何地方都找不到如何执行此操作...有人知道该怎么做吗？

【问题讨论】：

【解决方案1】：

您可以在文档中添加<img /> 标签：

 # Blah-blah 
 # 
 # <img src=img/1.png />
 # @param [String] blah
 # @return [String] blah
 def foo(bar) 

 end

【讨论】：

这对我有用（rails 3.1.0，Yard 0.7.2）。文本是 html 转义的：&lt;img src='img/1.png' /&gt;

【解决方案2】：

使用rdoc-image:链接：

# Gets foo.
#
# rdoc-image:img/1.png
def foo(bar)
  "foo"
end

由 YARD 渲染成

<p>Gets foo.</p>
<p><img src="img/1.png"></p>

rdoc-images: 也适用于独立的 *.rdoc 文件。

【讨论】：

【解决方案3】：

根据您的标记格式，您可能必须使用另一种机制。例如，如果您使用 Markdown，则语法为 ![Alt text](/path/to/img.jpg)。在 RDoc 中，一个 img 标签应该可以工作，但您可以检查他们是否为此添加了特殊的标记语法。请注意，RDoc 可能（不确定）不喜欢 XHTML，您应该使用不带结尾的 /。

【讨论】：