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

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

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

Взгляните на Документы

Tobias 26.11.2015 13:27
Пошаговое руководство по созданию собственного Slackbot: От установки до развертывания
Пошаговое руководство по созданию собственного Slackbot: От установки до развертывания
Шаг 1: Создание приложения Slack Чтобы создать Slackbot, вам необходимо создать приложение Slack. Войдите в свою учетную запись Slack и перейдите на...
46
1
1 863
2

Ответы 2

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

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

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

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