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

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

# Returns a <label> field...

经码加工后成为

Return a field...

<label>元素实际上是通过yard逐字传递，使其作为原始html发送到浏览器。
我试着使用<label>来代替，结果被转义了，所以我在结果文档中得到了<label>。
谢谢！

最佳答案

Yard默认使用normalRDoc 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...

关于ruby-on-rails - 如何在Yard文档中输出HTML元素名称，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/9048963/