Uygun RDoc sözdizimi için iyi, sağlam bir referans arıyorum. Öneriler? Açıkça gösteren bir şey bulmak için görünmüyor olabilir:

1. Nasıl sınıf yöntemleri ve parametreleri belge
2. Nasıl bir sınıf veya sınıf yöntemi ne belge.

rdoc.rubyforge.org belgeler rdoc.sourceforge.net sürümü daha tam olacak bu arada 2003 değiştirilme tarihi olan) görünüyor.

Ayrıca, örneklerin büyük bir kaynak var: Ruby çekirdeği ve stdlib belgeleri. Örneğin, File class Sınıf yöntemlerden biri bir göz atın:

Dosya.atime(dosya_adı) =>zaman

Son erişim için zaman verir Zaman bir nesne dosyası) adlı.

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

İlk satırında (alıntı gerçek RDoc sayfasında, bu cevap ben dahil) tıklayarak orijinal kaynak kodu, RDoc biçimlendirme dahil olmak üzere görebilirsiniz. Bu durumda, yöntem C ' de uygulanan, ama RDoc biçimlendirme eğer Ruby uygulanan olsaydı aynıdır:

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

Bu call-seq: yöntemin adını değiştirmek ve sınıf yöntemleri için çok yararlı olan sizin seçtiğiniz metin ile parametreleri sağlar. Ayrıca bu girintileme tarafından örnek eş aralıklı yazı tipi kodu görüntüleme, fiyat indirimi için benzer gösterir.