от
Я хочу форматировать существующие комментарии как RDoc документации для комментариев, чтобы они могли быть просмотрены с помощью
ri
. Какие существуют рекомендуемые ресурсы для начинающих, используя RDoc документации?

Ваш ответ

Отображаемое имя (по желанию):
Конфиденциальность: Ваш электронный адрес будет использоваться только для отправки уведомлений.
Анти-спам проверка:
Чтобы избежать проверки в будущем, пожалуйста войдите или зарегистрируйтесь.

3 Ответы

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