Wie stelle ich eckige Klammern ([]) in RDoc?

Question

Ich versuche, einige Rake-Aufgaben zu dokumentieren, die ich mit RDoc-Kommentaren in meiner Klasse geschrieben habe, und stehe in Schwierigkeiten, eckige Klammern darzustellen. Ich möchte einige Beispiele hinzufügen, wie ich meine Rake-Aufgaben mit Parametern ausführen kann und so eine rdoc-Zeile wie folgt haben:

# eg. rake build[MyProject]

Das Problem besteht darin, dass der RDoc-Parser Convert eine Verknüpfung erstellt, anstatt die eckigen Klammern zu drucken. Ich habe alle möglichen Escape-Sequenzen ausprobiert: [; [[; #{[Mein Projekt]} ; & # 91; MyProject & # 93; aber nichts scheint zu funktionieren.

Gibt es eine Möglichkeit, diesen eckigen Klammern zu entkommen, so dass sie nicht zu einem Link konvertieren?

Danke, Aaron

Answer 1

Nun mit weiteren Experimenten entdeckte ich einen Weg, es zu tun. Wenn ich zwei Leerzeichen vor jede Zeile setze, behandelt RDoc die Zeile als vorformatierten Text und rendert die Klammern. Gut genug für mich.

Die resultierende RDoc Linie ist:

 
# eg. rake build[MyProject] 

Answer 2

Manchmal ist die Lösung einfach.

Code wie text[par] erstellt Text mit einem Link zu par. Aber wenn Sie ein Leerzeichen zwischen text und [par] setzen, erhalten Sie Par mit eckigen Klammern.

Ein kurzer Überblick über die verschiedenen Versionen mit []:

* [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. 

Wenn Sie den Text mit den text<space>[par] ige Lösung in kursiv machen wollen, müssen Sie die <em>...</em> Variante (nicht die Unterstrich-Variante _..._) verwenden.

Answer 3

Das Tag <tt> wird die Link-Text [Hyperlink] -Syntax umgehen (und auch den Text in eine Monospace-Schriftart setzen).

Also das rdoc

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

wird diese Dokumentation produzieren:

zB. rake build[MyProject]