Comment représenter des crochets ([]) dans RDoc?

Question

J'essaie de documenter certaines tâches rake que j'ai écrites en utilisant des commentaires RDoc dans ma classe et je rencontre des problèmes en représentant des crochets. Je veux ajouter quelques exemples de la façon d'exécuter mes tâches rake avec des paramètres et ainsi avoir une ligne rdoc comme ça:

# par ex. Le problème est que la conversion de l'analyseur RDoc crée un lien au lieu d'imprimer les crochets. J'ai essayé toutes sortes de séquences d'échappement: [; [[; #{[Mon projet]} ; & # 91; MyProject & # 93; mais rien ne semble fonctionner.

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

Merci, Aaron

Answer 1

bien avec d'autres expérimentations j'ai découvert une façon de le faire. Si je place deux espaces devant chaque ligne, RDoc traite la ligne comme du texte pré-formaté et restitue les crochets. Suffisant pour moi.

La ligne RDoc résultante est:

 
# eg. rake build[MyProject] 

Answer 2

Parfois, la solution est facile.

Le code text[par] crée le texte avec un lien au par. Mais si vous mettez un espace entre text et [par] vous obtenez par avec des crochets.

Un bref aperçu des 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 voulez rendre le texte avec le text<space>[par] -solution en italique, vous devez utiliser la variante <em>...</em> (pas le trait de soulignement variante _..._).

Answer 3

La balise <tt> va échapper à la syntaxe de lien hypertexte [lien hypertexte] (et également mettre le texte dans une police monospace).

Donc, ce rdoc

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

produira cette documentation:

par exemple. rake build[MyProject]