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

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