ruby - 如何在 RDoc 中表示方括号 ([])？

Question

我正在尝试记录我在课堂上使用 RDoc 注释编写的一些 rake 任务，并且在表示方括号时遇到了麻烦。我想添加一些示例，说明如何使用参数运行我的 rake 任务，因此有一个像这样的 rdoc 行：

# 例如。rake build[MyProject]

问题是 RDoc 解析器转换创建一个链接而不是打印方括号。我尝试了各种转义序列： [ ; [[ ; ＃{[我的项目]} ; [我的项目] 但似乎没有任何效果。

有什么办法可以逃避这些方括号，使它们不会转换为链接？

谢谢，亚伦

Answer 1

好吧，通过进一步的实验，我发现了一种方法。如果我在每行前面放置两个空格，RDoc 会将该行视为预先格式化的文本并呈现括号。对我来说已经足够好了。

生成的 RDoc 行是：

# 例如。耙构建[MyProject]

Answer 2

该<tt>标签将转义 link-text[hyperlink] 语法（并将文本置于等宽字体中）。

所以这个 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]使用斜体的 -solution 来制作文本，则必须使用<em>...</em>变体（而不是下划线变体_..._）。