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

Question

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

# Returns a <label> field...

在Yard处理后成为

Return a field...

<label>元素实际上是通过Yard逐字传递给浏览器的原始HTML。

我尝试使用<label>代替，并且已经转义，所以我最终在结果文档中使用了<label>。

谢谢！

Answer 1

Yard默认使用普通RDoc markup：

  

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

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”废话。但是，将<label>包装在RDoc的打字机标记中确实产生了一些有用的东西，所以试试这个：

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