Я хочу отформатировать мои существующие комментарии как «комментарии RDoc», чтобы их можно было просмотреть с помощью ri
.
Каковы некоторые рекомендуемые ресурсы для начала использования RDoc?
Посмотрите на Документы
Tobias
26.11.2015 10:27:37
2 ОТВЕТА
RDoc использует SimpleMarkup, поэтому довольно просто создавать списки и т. Д., Используя *, - или число. Он также обрабатывает строки, которые имеют отступ с тем же номером столбца, как часть одного и того же абзаца, пока не появится пустая строка, обозначающая новый абзац. У вас есть несколько примеров комментариев, которые вы хотите добавить в RDoc, чтобы мы могли показать вам, как их делать, а затем вы могли бы экстраполировать это для остальных ваших комментариев?
9
Rob Burke
2.08.2008 10:22:41
Несколько вещей, которые меня укусили:
:main:
- RDoc использует только последний оцененный; Лучше всего убедиться, что в вашем проекте есть только один, и вы также не используете--main
аргумент командной строки.- такой же, как предыдущий, но для
:title:
:section:
не очень хорошо работает
15
James A. Rosen
23.08.2008 04:48:20