Como faço para representar suportes quadrados ([]) no RDOC?

Question

Estou tentando documentar algumas tarefas de rake que escrevi usando comentários RDOC na minha classe e estou tendo problemas para representar colchetes. Quero adicionar alguns exemplos de como executar minhas tarefas de rake com parâmetros e, portanto, tenha uma linha RDOC como assim:

# por exemplo. rake build[MyProject]

O problema é que o analisador RDOC converta cria um link em vez de imprimir os colchetes. Eu tentei todos os tipos de sequências de fuga: [; [[;; #{[Meu projeto]} ; [MyProject] Mas nada parece funcionar.

Existe alguma maneira de escapar desses suportes quadrados para que eles não se convertem em um link?

Obrigado, Aaron

Answer 1

Bem, com mais experimentações, descobri uma maneira de fazê -lo. Se eu colocar dois espaços na frente de cada linha, o RDOC trata a linha como texto pré -formatado e renderiza os colchetes. Bom o suficiente para mim.

A linha RDOC resultante é:

#  eg. rake build[MyProject]

Answer 2

o <tt> A tag escapará da sintaxe Link-Text [Hyperlink] (e também colocará o texto em uma fonte monoespacial).

Então, este rdoc

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

produzirá esta documentação:

por exemplo. rake build[MyProject]

Answer 3

Às vezes, a solução é fácil.

Código como text[par] cria texto com um link para o PAR. Mas se você colocar um espaço entre text e [par] você fica par com suportes quadrados.

Uma breve visão geral de versões diferentes com []:

* [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 você quiser fazer o texto com o text<space>[par]-Solução em itálico, você deve usar o <em>...</em> variante (não a variante sublinhada _..._).