Как мне представить квадратные скобки ([]) в RDoc? - PullRequest
3 голосов
/ 18 ноября 2010

Я пытаюсь задокументировать некоторые грабли, которые я написал, используя комментарии RDoc в моем классе, и столкнулся с проблемой, представляющей квадратные скобки. Я хочу добавить несколько примеров того, как запускать мои грабли с параметрами и иметь строку rdoc, например:

# например. rake build[MyProject]

Проблема в том, что конвертер парсера RDoc создает ссылку вместо печати в квадратных скобках. Я перепробовал все виды escape-последовательностей: [; [[; #{[Мой проект]} ; [MyProject], но, похоже, ничего не работает.

Можно ли как-нибудь избежать этих квадратных скобок, чтобы они не конвертировались в ссылку?

Спасибо, Aaron

Ответы [ 3 ]

2 голосов
/ 18 ноября 2010

Ну, с дальнейшими экспериментами я нашел способ сделать это. Если я помещу два пробела перед каждой строкой, RDoc обрабатывает строку как предварительно отформатированный текст и отображает скобки. Достаточно хорошо для меня.

Результирующая строка RDoc:

#  eg. rake build[MyProject]
1 голос
/ 13 сентября 2015

Тег <tt> не содержит синтаксиса link-text [hyperlink] (а также помещает текст в моноширинный шрифт).

Итак, этот rdoc

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

выдаст эту документацию:

например. rake build[MyProject]

0 голосов
/ 03 августа 2012

Иногда решение простое.

Код типа text[par] создает текст со ссылкой на пар.Но если вы поставите пробел между text и [par], вы получите par в квадратных скобках.

Краткий обзор различных версий с []:

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

Если вы хотите сделать текст с text<space>[par] -сводным курсивом, вы должны использовать вариант <em>...</em> (а не вариант подчеркивания _..._).

...