如何在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中表示方括號（[]）？

回答

相關問題