Có một tham chiếu tốt, vững chắc cho cú pháp RDoc thích hợp không?

Tôi đang tìm kiếm một tài liệu tham khảo tốt, chắc chắn cho cú pháp RDoc thích hợp. Khuyến nghị? Tôi dường như không thể tìm thấy bất cứ điều gì cho thấy rõ ràng:

1. Cách ghi lại các phương thức của lớp và các tham số của chúng
2. Cách ghi lại những gì một lớp hoặc phương thức lớp làm.

Một ví dụ rdoc chính thức có thể được tìm thấy ở đây , với nguồn GitHub của nó .

Tài liệu tại rdoc.rubyforge.org dường như đầy đủ hơn phiên bản tại rdoc.sourceforge.net (tình cờ có ngày sửa đổi năm 2003).

Ngoài ra, có một nguồn ví dụ tuyệt vời: lõi Ruby và tài liệu stdlib. Ví dụ: hãy xem một trong các phương thức lớp từ Filelớp :

File.atime (file_name) => thời gian

Trả về thời gian truy cập cuối cùng cho tệp được đặt tên dưới dạng đối tượng Thời gian).

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

Bạn có thể xem mã nguồn ban đầu, bao gồm cả phần đánh dấu RDoc, bằng cách nhấp vào dòng đầu tiên (trong trang RDoc thực tế, không phải trong phần trích dẫn mà tôi đã đưa vào câu trả lời này). Trong trường hợp này, phương thức được triển khai trong C, nhưng định dạng RDoc giống như khi nó được triển khai trong 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
 *     
 */

Từ đó, bạn có thể thấy rằng nó call-seq:cho phép bạn thay thế tên phương thức và các tham số bằng văn bản bạn chọn, điều này rất hữu ích cho các phương thức lớp. Nó cũng chỉ ra cách bạn có thể hiển thị mã ví dụ bằng phông chữ monospaced bằng cách thụt lề, tương tự như Markdown.

Vì RubyForge đã ngừng hoạt động , đây là một liên kết mới:

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