Как добавить существующие комментарии к RDoc в Ruby?

Я хочу отформатировать существующие комментарии как "комментарии RDoc", чтобы их можно было просмотреть с помощью ri.

Каковы рекомендуемые ресурсы для запуска с использованием RDoc?

Ответы

Ответ 1

Несколько вещей, которые укусили меня:

:main: - RDoc использует только последнюю оценку; чтобы убедиться, что в вашем проекте только один, и вы также не используете аргумент командной строки --main.
аналогично предыдущему, но для :title:
:section: работает не очень хорошо

Ответ 2

RDoc использует SimpleMarkup, поэтому довольно просто создавать списки и т.д., используя *, - или число. Он также обрабатывает строки с отступом в том же столбце, что и часть того же абзаца, до тех пор, пока не будет пустая строка, которая означает новый абзац. У вас есть несколько примеров комментариев, которые вы хотите использовать RDoc'ed, чтобы мы могли показать вам, как их выполнять, а затем вы можете экстраполировать это для остальных своих комментариев?