如何使用RDoc标记呈现逐字/代码/预加号?

时间:2011-10-24 23:06:14

标签: ruby markup rdoc

使用RDoc标记并使用Yard生成文档,我正在尝试记录一些命令输出,其中包含以下行:

+----------------------------------+

......但无法弄清楚如何实现这一目标。我怎样才能得到HTML:

<pre class="code">
  +----------------------------------+
</pre>

我确信我在文档中遗漏了一些微不足道的东西......


尝试#1

不试图逃避标记,我缩进了这2个空格(就像任何其他代码/ pre块一样):

+----------------------------------+

...生成文档,然后获取HTML(我猜想如预期的那样):

<pre class="code">
  <tt>----------------------------------</tt>
</pre>

尝试#2

如果我使用反斜杠来逃避,这个标记:

\+----------------------------------+

...成为这个HTML:

<pre class="code">
  \+----------------------------------+
</pre>

尝试#3

奇怪的是,如果我连续使用两个加号,这个标记:

++----------------------------------+

...成为这个HTML:

<pre class="code">
  ++----------------------------------+
</pre>

尝试#4

使用无缩进的<tt>只留下非“逐字”(即预/代码)部分;只是纯文本(再次,正如预期的那样,我想):

<tt>+----------------------------------+</tt>

...成为这个HTML:

<p>
  <tt>-------------------------------------</tt>
</p>

尝试#5

使用缩进<tt>会转换此标记:

<tt>+----------------------------------+</tt>

...进入此HTML:

<pre class="code">
  <tt>+----------------------------------+</tt>
</pre>

1 个答案:

答案 0 :(得分:0)

这是一个错误并在院子里修复:https://github.com/lsegal/yard/issues/403