Как мне добавить существующие комментарии в RDoc в Ruby?[закрыто]
Вопрос
Я хочу отформатировать свои существующие комментарии как "Комментарии RDoc", чтобы их можно было просматривать с помощью ri
.
Каковы некоторые рекомендуемые ресурсы для начала использования RDoc?
Нет правильного решения
Другие советы
Несколько вещей, которые меня укусили:
:main:
-- RDoc использует только последний оцененный;лучше всего убедиться, что в вашем проекте есть только один, и вы также не используете--main
аргумент командной строки.- то же, что и в предыдущем, но для
:title:
:section:
работает не очень хорошо
RDoc использует SimpleMarkup, поэтому создавать списки и т.д. Довольно просто.используя *, - или число.Он также обрабатывает строки с отступом под тем же номером столбца как часть того же абзаца, пока не останется пустая строка, обозначающая новый абзац.У вас есть несколько примеров комментариев, которые вы хотите отредактировать в RDoc, чтобы мы могли показать вам, как это сделать, а затем вы могли бы экстраполировать это на остальные ваши комментарии?
Не связан с StackOverflow