如何在RDoc中表示方括号（[]）？

我正在尝试记录我在课堂上使用RDoc注释编写的一些耙子任务，并遇到代表方括号的麻烦。我想添加一些关于如何使用参数运行我的rake任务的例子，所以有如下的rdoc行：如何在RDoc中表示方括号（[]）？

＃eg。 rake build[MyProject]

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

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

感谢，亚伦

来源

2010-11-18 Aaron Janes

那么进一步的实验，我发现一个办法做到这一点。如果我在每行前面放置两个空格，RDoc将该行视为预格式化文本并呈现括号。对我来说足够了。

将所得的RDoc行是：

 
# eg. rake build[MyProject]

来源

2010-11-18 12:52:53

缩进是正确的，因为你正在显示一个编码样本。它应该缩进并以固定宽度的字体显示，因为这是公认的惯例。 – 2010-11-28 06:20:04

继续并接受你对这个问题的回答。这样它就会显示为已经在SO界面中得到了回答。 – 2010-11-28 06:22:33

有时溶液是容易的。

像text[par]这样的代码创建文本与链接到参数。但是如果你在text和[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>变种（未下划线变种_..._）。

来源

2012-08-03 19:26:55 knut

<tt>标记将转义链接文本[超链接]语法（并且还将文本置于等宽字体中）。

所以这RDoc的

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

会产生这个文件：

如。 rake build[MyProject]

来源

2015-09-13 15:43:47

如何在RDoc中表示方括号（[]）？

回答

相关问题