Есть ли хороший и надежный справочник по правильному синтаксису RDoc?

Я ищу хороший, надежный справочник по правильному синтаксису RDoc. Рекомендации? Кажется, я не могу найти ничего, что ясно показывает:

1. Как документировать методы класса и их параметры
2. Как документировать, что делает класс или метод класса.

Официальный пример rdoc можно найти здесь с исходным кодом GitHub .

Документация на rdoc.rubyforge.org кажется более полной, чем версия на rdoc.sourceforge.net (которая, кстати, имеет дату изменения 2003 г.).

Кроме того, есть отличный источник примеров: ядро ​​Ruby и документация stdlib. Например, взгляните на один из методов класса из Fileкласса :

File.atime (имя_файла) => время

Возвращает время последнего доступа к названному файлу как объект Time).

File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003

Вы можете просмотреть исходный код, включая разметку RDoc, щелкнув первую строку (на фактической странице RDoc, а не в цитате, которую я включил в этот ответ). В данном случае метод был реализован на C, но форматирование RDoc такое же, как если бы оно было реализовано в Ruby:

/*
 *  call-seq:
 *     File.atime(file_name)  =>  time
 *  
 *  Returns the last access time for the named file as a Time object).
 *     
 *     File.atime("testfile")   #=> Wed Apr 09 08:51:48 CDT 2003
 *     
 */

Из этого вы можете видеть, что это call-seq:позволяет вам заменять имя метода и параметры текстом по вашему выбору, что очень полезно для методов класса. Он также показывает, как можно отобразить пример кода моноширинным шрифтом, сделав для него отступ, аналогично Markdown.

Поскольку RubyForge был удален , вот новая ссылка:

http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/RDoc/Markup.html