Doğru RDoc sözdizimi için iyi ve sağlam bir referans arıyorum. Öneriler? Açıkça gösteren hiçbir şey bulamıyorum:
- Sınıf yöntemleri ve parametreleri nasıl belgelenir
- Bir sınıf veya sınıf yönteminin ne yaptığını belgeleme.
Doğru RDoc sözdizimi için iyi ve sağlam bir referans arıyorum. Öneriler? Açıkça gösteren hiçbir şey bulamıyorum:
Yanıtlar:
Resmi bir rdoc örneği , GitHub kaynağıyla burada bulunabilir .
En dokümantasyon rdoc.rubyforge.org de sürümden daha eksiksiz olarak görünüyor rdoc.sourceforge.net (bu arada 2003 değiştirilme tarihini vardır).
Ayrıca harika bir örnek kaynağı var: Ruby çekirdeği ve stdlib belgeleri. Örneğin, Sınıf yöntemlerden birini bakmak Filesınıfta :
File.atime (file_name) => zaman
Adlandırılmış dosya için son erişim zamanını Time nesnesi olarak döndürür).
File.atime("testfile") #=> Wed Apr 09 08:51:48 CDT 2003
RDoc işaretlemesi dahil olmak üzere orijinal kaynak kodunu ilk satıra tıklayarak görüntüleyebilirsiniz (gerçek RDoc sayfasında, bu cevaba dahil ettiğim alıntıda değil). Bu durumda, yöntem C'de uygulandı, ancak RDoc biçimlendirmesi Ruby'de uygulanıyormuş gibi 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
*
*/
Buradan call-seq:, yöntem adını ve parametrelerini seçtiğiniz metinle değiştirmenize izin verdiğini görebilirsiniz; bu, sınıf yöntemleri için çok yararlıdır. Ayrıca, Markdown'a benzer şekilde, tek aralıklı bir yazı tipinde örnek kodu nasıl girintilendirerek görüntüleyebileceğinizi gösterir.
--markup(kullanmak çalışırken seçeneği markdownde belirtildiği rdoc.rubyforge.org/RDoc/Markup.html#label-Supported+ Biçimler - Bir şey mi kaçırıyorum?
Yana Paketleme sistemini RubyForge emekli edilmiş , burada yeni bir link:
http://ruby-doc.org/stdlib-2.5.1/libdoc/rdoc/rdoc/RDoc/Markup.html