web-dev-qa-db-ja.com

適切なRDoc構文の適切な参照がありますか?

適切なRDoc構文の優れた堅実なリファレンスを探しています。推奨事項私は明確に示すものを見つけることができないようです:

  1. クラスメソッドとそのパラメーターを文書化する方法
  2. クラスまたはクラスメソッドの機能を文書化する方法。
81
Levi Hackwith

公式のrdocの例は here で、その GitHubソース にあります。

rdoc.rubyforge.org のドキュメントは rdoc.sourceforge.net (ついでに2003年の修正日があります)のバージョンよりも完全であるようです。

また、例の素晴らしいソースがあります:Ruby coreとstdlibのドキュメント。たとえば、 Fileのクラスメソッドの1つを見てください。クラス

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と同様に、サンプルコードをインデントすることにより等幅フォントで表示する方法も示しています。

32
bk1e
21
Myers Carpenter