Wie repräsentiere ich quadratische Klammern ([]) in RDOC?

Question

Ich versuche einige Rake -Aufgaben zu dokumentieren, die ich mit RDOC -Kommentaren in meiner Klasse geschrieben habe, und ich gerate in Schwierigkeiten, die quadratische Klammern darzustellen. Ich möchte einige Beispiele dafür hinzufügen, wie ich meine Rake -Aufgaben mit Parametern ausführen kann, und so eine RDOC -Linie wie SO:

# z.B. rake build[MyProject]

Das Problem ist, dass der RDOC -Parser Convert einen Link erstellt, anstatt die quadratischen Klammern zu drucken. Ich habe alle möglichen Fluchtsequenzen ausprobiert: [; [[; #{[Mein Projekt]} ; [MyProject] Aber nichts scheint zu funktionieren.

Gibt es eine Möglichkeit, diesen quadratischen Klammern zu entkommen, damit sie nicht zu einem Link konvertiert werden?

Danke, Aaron

Answer 1

Mit weiteren Experimenten entdeckte ich einen Weg, dies zu tun. Wenn ich zwei Plätze vor jede Zeile stelle, behandelt RDOC die Linie als vor Formatierter Text und rendert die Klammern. Gut genug für mich.

Die resultierende RDOC -Linie lautet:

#  eg. rake build[MyProject]

Answer 2

Das <tt> Tag entgeht der Link-Text-Syntax [Hyperlink] (und steckt auch den Text in eine Monospace-Schrift).

Also dieser RDOC

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

wird diese Dokumentation erstellen:

z.B. rake build[MyProject]

Answer 3

Manchmal ist die Lösung einfach.

Code wie text[par] schafft Text mit einem Link zu Par. Aber wenn Sie einen Raum dazwischen legen text und [par] du erhältst Par mit quadratischen Klammern.

Ein kurzer Überblick über verschiedene 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 dem erstellen möchten text<space>[par]-Lösung in Kursivschrift, Sie müssen die verwenden <em>...</em> Variante (nicht die Unterstrichvariante _..._).