Comment représenter les crochets ([]) dans RDOC?

Question

J'essaie de documenter certaines tâches de râteau que j'ai écrites en utilisant des commentaires RDOC dans ma classe et j'ai rencontré des difficultés à représenter les crochets. Je veux ajouter quelques exemples de comment exécuter mes tâches de râteau avec des paramètres et donc avoir une ligne RDOC comme tel:

# par exemple. rake build[MyProject]

Le problème est que le converti RDOC Parser crée un lien au lieu d'imprimer les crochets. J'ai essayé toutes sortes de séquences d'échappement: [; [[; #{[Mon projet]} ; [Myproject] mais rien ne semble fonctionner.

Existe-t-il un moyen d'échapper à ces crochets afin qu'ils ne se convertissent pas en lien?

Merci, Aaron

Answer 1

Eh bien, avec une nouvelle expérimentation, j'ai découvert un moyen de le faire. Si je mets deux espaces devant chaque ligne, RDOC traite la ligne comme du texte pré-formaté et rend les supports. Suffisant pour moi.

La ligne RDOC résultante est:

#  eg. rake build[MyProject]

Answer 2

La <tt> La balise échappera à la syntaxe de texte link-text [hyperlien] (et mettra également le texte dans une police monospace).

Donc ce rdoc

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

produira cette documentation:

par exemple. rake build[MyProject]

Answer 3

Parfois, la solution est facile.

Code comme text[par] crée texte avec un lien vers le par. Mais si vous mettez un espace entre text et [par] vous obtenez par avec crochets.

Un bref aperçu de différentes versions avec []:

* [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 vous souhaitez faire le texte avec le text<space>[par]-Solution en italique, vous devez utiliser le <em>...</em> variante (pas la variante de soulignement _..._).