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

голоса
36

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

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

Задан 01/08/2008 в 14:38
источник пользователем
На других языках...                            


2 ответов

голоса
14

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

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

голоса
9

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

Ответил 02/08/2008 d 11:22
источник пользователем

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more