適切なRDOC構文のための適切な堅実な参照はありますか？

Question

適切なRDOC構文のための優れた堅実な参照を探しています。推奨事項？はっきりと示されているものを見つけることができないようです。

1. クラスメソッドとそのパラメーターを文書化する方法
2. クラスやクラスの方法が何をするかを文書化する方法。

Answer 1

公式のRDOCの例を見つけることができます ここ, 、それで githubソース.

でのドキュメント rdoc.rubyforge.org バージョンよりも完全なようです rdoc.sourceforge.net （偶然にも2003年の変更日があります）。

また、例の優れたソースがあります：Ruby CoreとStdlibのドキュメント。たとえば、からのクラスメソッドの1つをご覧ください File クラス:

file.atime（file_name）=> time

名前付きファイルの最後のアクセス時間をTimeオブジェクトとして返します）。

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は引退しました, 、ここに新しいリンクがあります：

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