如何代表RDOC中的方括号（[]）？

Question

我正在尝试记录我在课堂上使用RDOC注释所写的一些耙子任务，并且遇到了代表方括号的麻烦。我想添加一些有关如何使用参数运行耙子任务的示例，因此请使用类似的RDOC行：

＃例如。 rake build[MyProject]

问题在于RDOC解析器转换会创建链接而不是打印方括号。我尝试了各种逃生序列：[; [[; ＃{[我的项目]} ; [myproject]，但似乎没有任何作用。

有什么方法可以逃脱这些方括号，以免转换为链接？

谢谢，亚伦

Answer 1

好吧，通过进一步的实验，我发现了一种方法。如果我将两个空间放在每条线的前面，RDOC将行视为预格式的文本，并将其呈现括号。对我来说足够好。

最终的RDOC线是：

#  eg. rake build[MyProject]

Answer 2

这 <tt> 标签将逃脱链接文本[超链接]语法（还将文本放入单拼字体中）。

所以这个RDOC

# eg. <tt>rake build[MyProject]</tt>

将产生此文档：

例如。 rake build[MyProject]

Answer 3

有时解决方案很容易。

代码喜欢 text[par] 创建 文本 与PAR的链接。但是，如果您在 text 和 [par] 你得到 par 带有方括号。

使用[]的不同版本的简短概述：

* [par] labeled list
* x[par] x is linked with par
* x [par] Text as is (space between x and par)
* []  brackets disapear
* x _[par]_  Content between[] disapears.

如果您想用 text<space>[par]- 斜体，您必须使用 <em>...</em> 变体（不是下划线变体 _..._).