Как я могу представлять квадратные кронштейны ([]) в RDOC?

StackOverflow https://stackoverflow.com/questions/4214726

  •  26-09-2019
  •  | 
  •  

Вопрос

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

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

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

Есть ли способ избежать этих квадратных скобок, поэтому они не преобразуют ссылку?

Спасибо, Аарон

Это было полезно?

Решение

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

Полученную строку RDOC:

# например. Rake Build [MyProject

Другие советы

То <tt> Тег потеряет ссылку-текст [HyperLink] Syntax (а также поместить текст в моноспатином шрифте).

Так что это Rdoc.

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

будет производить эту документацию:

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

Иногда решение легко.

Код вроде text[par] создает текст со ссылкой на пар. Но если вы поместите пространство между text а также [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> вариант (не вариант подчеркивания _..._).

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top