[解決済み] RDoc の正しい構文について、良い参考文献はありますか？

質問

正しいRDocの構文について、しっかりした参考文献を探しています。お勧めはありますか。私は明確に示している何かを見つけることができないようです。

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

どのように解決するのですか？

公式の rdoc の例があります。 ここで で、その GitHub のソース .

のドキュメントは rdoc.rubyforge.org にあります。 にあるバージョンよりも充実しているようです。 rdoc.sourceforge.net にあるバージョンよりも完全なようです (ちなみに、このバージョンは 2003 年に更新されています)。

また、Rubyのコアとstdlibのドキュメントという素晴らしい例のソースがあります。例えば、Ruby のクラスメソッドのひとつである File クラス :

ファイル.atime(ファイル名) => 時間

指定されたファイルの最終アクセス時刻を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と同様にインデントすることで、等幅フォントでサンプルコードを表示する方法も示しています。