ruby-on-rails - 如何在 Yard 文档中输出 HTML 元素名称

Question

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

# Returns a <label> field...

由 Yard 处理后变为

Return a field...

该<label>元素实际上是通过 Yard 逐字传递，使其作为原始 HTML 传递给浏览器。

我尝试<label>改用，但它被转义了，所以我最终得到<label>了结果文档。

谢谢！

Answer 1

Yard 默认使用普通的RDoc 标记：

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

RDoc 有这样的说法：

在内联标记之前放置一个反斜杠会阻止它被解释，这就是我创建上表的方式：

_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...