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

Question

我正在嘗試記錄我在課堂上使用RDoc注釋編寫的一些rake任務，並且遇到代表方括號的麻煩。 我想添加一些如何使用參數運行rake任務的示例，因此有一個像這樣的rdoc行：

＃例如。 rake build[MyProject]

問題是RDoc解析器轉換創建一個鏈接而不是打印方括號。 我嘗試過各種各樣的逃逸序列：[; [[; ＃{[我的項目]} ; ＆＃91; MyProject的＆＃93; 但似乎沒什么用。

有沒有辦法逃避這些方括號，所以他們不轉換為鏈接？

謝謝你，亞倫

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] 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>變體（而不是下划線變體_..._ ）。