Come posso rappresentare parentesi quadrate ([]) in rdoc?

Question

Sto cercando di documentare alcune attività di rastrello che ho scritto usando commenti RDOC nella mia classe e mi sto imbattendo nei guai a rappresentare parentesi quadrate. Voglio aggiungere alcuni esempi di come eseguire le mie attività di rastrello con parametri e quindi avere una linea RDOC come così:

# per esempio. rake build[MyProject]

Il problema è che il parser RDOC converti crea un collegamento invece di stampare le staffe quadrate. Ho provato tutti i tipi di sequenze di fuga: [; [[; #{[Il mio progetto]} ; [MyProject] Ma nulla sembra funzionare.

C'è un modo per sfuggire a queste parentesi quadrate in modo che non si convertino in un link?

Grazie, Aaron

Answer 1

Bene, con l'ulteriore sperimentazione ho scoperto un modo per farlo. Se metto due spazi davanti a ciascuna riga, RDOC tratta la linea come testo pre -formattato e rende le staffe. Abbastanza buono per me.

La linea RDOC risultante è:

#  eg. rake build[MyProject]

Answer 2

Il <tt> Il tag sfuggirà alla sintassi Link-Text [HyperLink] (e metterà anche il testo in un carattere monospaziale).

Quindi questo rdoc

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

produrrà questa documentazione:

per esempio. rake build[MyProject]

Answer 3

A volte la soluzione è facile.

Codice come text[par] crea testo con un collegamento al par. Ma se metti uno spazio tra text e [par] ottieni par con parentesi quadrate.

Una breve panoramica di diverse versioni con []:

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

Se vuoi fare il testo con il text<space>[par]-soluzione in corsivo, devi usare il <em>...</em> variante (non la variante di sottolineatura _..._).