如何在RDoc中表示方括号([])?

时间:2010-11-18 12:28:09

标签: ruby rdoc

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

#eg。 rake build[MyProject]

问题是RDoc解析器转换创建了一个链接,而不是打印方括号。我尝试过各种各样的逃逸序列:[; [[; #{[我的项目]} ; &安培;#91;&MyProject的放大器;#93;但似乎没什么用。

有没有办法逃避这些方括号,以便它们不会转换为链接?

谢谢, 亚伦

2 个答案:

答案 0 :(得分:2)

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

生成的RDoc行是:

#  eg. rake build[MyProject]

答案 1 :(得分:0)

有时解决方案很简单。

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>变体(不是下划线变体_..._)。