【发布时间】:2011-10-24 23:06:14
【问题描述】:
使用 RDoc 标记并使用 Yard 生成文档,我正在尝试记录一些具有如下行的命令输出:
+----------------------------------+
...但无法弄清楚如何实现这一点。我怎样才能得到 HTML:
<pre class="code">
+----------------------------------+
</pre>
我确定我错过了文档中的一些琐碎内容...
试试#1
在不试图转义标记的情况下,我缩进了这 2 个空格(就像任何其他代码/预块一样):
+----------------------------------+
...生成文档,并获取 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>
【问题讨论】:
-
看起来是 Yard 的潜在问题。通过 rdoc 3.10 生成时,这渲染得很好。
-
用 Yard 记录的错误:github.com/lsegal/yard/issues/403