Czy istnieje dobre, solidne odniesienie do prawidłowej składni RDoc?

Szukam dobrego, solidnego odniesienia do prawidłowej składni RDoc. Zalecenia? Nie mogę znaleźć niczego, co wyraźnie pokazuje:

Jak dokumentować metody klas i ich parametry
Jak udokumentować działanie klasy lub metody klas.

ruby rdoc

— Levi Hackwith
źródło

Oficjalny przykład rdoc można znaleźć tutaj , wraz ze źródłem GitHub .

Dokumentacja na rdoc.rubyforge.org wydaje się być bardziej kompletna niż wersja na rdoc.sourceforge.net (która notabene ma datę modyfikacji 2003).

Jest też świetne źródło przykładów: rdzeń Ruby i dokumentacja standardowej biblioteki. Na przykład spójrz na jedną z metod klasy z Fileklasy :

File.atime (file_name) => czas

Zwraca czas ostatniego dostępu do nazwanego pliku jako obiekt Time).

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

Możesz wyświetlić oryginalny kod źródłowy, w tym znaczniki RDoc, klikając pierwszą linię (na rzeczywistej stronie RDoc, a nie w cytacie, który zawarłem w tej odpowiedzi). W tym przypadku metoda została zaimplementowana w C, ale formatowanie RDoc jest takie samo, jak gdyby zostało zaimplementowane w Rubim:

/*
 *  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
 *     
 */

Z tego widać, że call-seq:pozwala zastąpić nazwę metody i parametry wybranym tekstem, co jest bardzo przydatne w przypadku metod klasowych. Pokazuje również, jak można wyświetlić przykładowy kod czcionką o stałej szerokości, wciskając ją, podobnie jak w przypadku Markdown.

— bk1e
źródło

Właśnie tego szukałem. Zauważ, że rdoc.rubyforge.org/RDoc/Markup.html ma (jak się wydaje) oficjalną specyfikację. Szukaj: RDoc Markup Reference Darn! Naprawdę powinienem był przeczytać również drugi komentarz

— Martin M.

Nie jestem pewien, czy dotyczy to również nowszych wersji, ale z moim rubinem 1.9.3 wydaje się, że nie obsługuje tej --markupopcji (próba użycia markdownwspomnianego na rdoc.rubyforge.org/RDoc/Markup.html#label-Supported+ Formaty - czy czegoś mi brakuje?

— FriendFX,

linki rubyforge nie działają.

— Ciro Santilli 郝海东冠状病六四事件法轮功

Docs.seattlerb.org/rdoc/RDoc/Markup.html to jedyne działające łącze, które pozostało na tej stronie. Czy edytować odpowiedź, by użyć tej?

— Mark Amery,

Nie mogłem znaleźć odnośnika do kodu źródłowego, jak wspomniano w odpowiedzi (która mówi, że dostęp do niego uzyskuje się po „kliknięciu pierwszej linii (na rzeczywistej stronie RDoc, a nie w cytacie, który zawarłem w tej odpowiedzi)”. Oto link do kodu źródłowego modułu Ruby File

— gene_wood