Сведения о вопросе

Holish

16:03, 1st July, 2020

Теги

ruby   rdoc    

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

Просмотров: 4241   Ответов: 2

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

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



  Сведения об ответе

Chhiki

18:03, 1st July, 2020

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

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


  Сведения об ответе

JUST___

18:03, 1st July, 2020

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


Ответить на вопрос

Чтобы ответить на вопрос вам нужно войти в систему или зарегистрироваться