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

Question

我想在Yard生成的ruby类文档中包含一些超文本标记语言元素名称，比如<label>。但它不起作用。例如，这句话

# Returns a <label> field...

经过堆场处理后，成为

Return a field...

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

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

谢谢!

Answer 1

默认情况下，Yard使用普通RDoc markup：

默认情况下，YARD与大多数

开发人员已经熟悉的RDoc语法兼容。

和RDoc has this to say

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

_italic_:：\_word_或\text *粗体*：：\*word*或\text +typewriter+:：+word+或\text

这表明：

# Returns a \<label> field...

应该可以工作，但这对我没有什么用处，只是更多的“传递给HTML”的废话。但是，将<label>包装在RDoc的typewriter标记中确实会产生一些有用的东西，因此可以尝试这样做：

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