如何在Yard文档中输出HTML元素名称

Question

我想在Yard生成的ruby类文档中包含一些HTML元素名称，如<label>。但它不起作用。例如，句子

# Returns a <label> field... 

由堆场

Return a field... 

<label>该元件实际上是通过逐字通过堆场能够进入浏览器作为原始HTML变为处理之后。

我试着用<label>来代替，结果这个文件中有<label>。

谢谢！

Answer 1

堆场使用正常RDoc markup默认：

默认情况下，YARD是相同的RDoc语法绝大多数Ruby开发者已经熟悉兼容。

而且RDoc has this to say：

把内标记前反斜杠停止它被解释，这是我如何创建上面的表格：

_italic_::  \_word_ or \<em>text</em> 
*bold*::  \*word* or \<b>text</b> 
+typewriter+:: \+word+ or \<tt>text</tt> 

这表明这一点：

# Returns a \<label> field... 

应该可以工作，但这对我没有任何用处，只是更多相同的“传递给HTML”废话。然而，在的RDoc的打字机标记包裹<label>确实产生了一些有用的东西所以试试这个：

# Returns a +<label>+ field...