Есть ли хорошая, надежная ссылка для правильного синтаксиса RDoc?

Question

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

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

Answer 1

Update битую ссылку документацию последней RDoc можно найти здесь https://ruby.github.io/rdoc/ExampleRDoc_rdoc.html

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

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

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

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

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.

Answer 2

С RubyForge has been retired, вот новая ссылка:

http://ruby-doc.org/gems/docs/r/rdoc-4.1.1/RDoc/Markup.html