¿Cómo represento soportes cuadrados ([]) en RDOC?

Question

Estoy tratando de documentar algunas tareas de rastrillo que he escrito usando comentarios de RDOC en mi clase y me estoy encontrando con problemas para representar corchetes. Quiero agregar algunos ejemplos de cómo ejecutar mis tareas de rastrillo con parámetros y, por lo tanto, tener una línea RDOC como así:

# p.ej. rake build[MyProject]

El problema es que la conversión de analizador RDOC crea un enlace en lugar de imprimir los soportes cuadrados. He probado todo tipo de secuencias de escape: [; [[; #{[Mi proyecto]} ; [Myproject] Pero nada parece funcionar.

¿Hay alguna forma de escapar de estos soportes cuadrados para que no se conviertan en un enlace?

Gracias Aaron

Answer 1

Bueno, con una mayor experimentación descubrí una forma de hacerlo. Si pongo dos espacios frente a cada línea, RDOC trata la línea como texto preformateado y representa los soportes. Suficientemente bueno para mi.

La línea RDOC resultante es:

#  eg. rake build[MyProject]

Answer 2

los <tt> La etiqueta escapará de la sintaxis del texto del enlace [Hyperlink] (y también pondrá el texto en una fuente monoespacial).

Entonces este rdoc

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

producirá esta documentación:

p.ej. rake build[MyProject]

Answer 3

A veces la solución es fácil.

Código como text[par] crea texto con un enlace a la par. Pero si pones un espacio entre text y [par] usted obtiene par con soportes cuadrados.

Una breve descripción de diferentes versiones 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.

Si quieres hacer el texto con el text<space>[par]-Solution en cursiva, debes usar el <em>...</em> variante (no la variante de subrayamiento _..._).