適切なRDoc構文の適切で確実なリファレンスはありますか?


83

私は適切なRDoc構文のための良い、しっかりしたリファレンスを探しています。推奨事項?はっきりとわかるものが見つからないようです。

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

回答:


32

公式のrdocの例は、GitHubソースとともにここにあります

ドキュメントrdoc.rubyforge.orgは時のバージョンよりもより完全であるように思わrdoc.sourceforge.net(ちなみに2003更新日を持っています)。

また、Rubyコアとstdlibのドキュメントなどの優れた例のソースがあります。例えば、からクラスのメソッドのいずれかを見てみましょうFileクラス

File.atime(file_name)=>時間

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


5
私はこれを探していました。rdoc.rubyforge.org/RDoc/Markup.htmlには(見たところ)公式の仕様があることに注意してください。検索:RDocマークアップリファレンス Darn!私は本当に2番目のコメントも読むべきでした
Martin M.

それが新しいバージョンにも当てはまるかどうかはわかりませんが、私の1.9.3ルビーでは、この--markupオプションをサポートしていないようです(rdoc.rubyforge.org/RDoc/Markup.html#label-Supported+でmarkdown言及されているものを使用しようとしています)フォーマット-何かが足りないのですか?
FriendFX 2013年

3
rubyforgeリンクが死んでいます。
CiroSantilli郝海东冠状病六四事件法轮功2014

3
docs.seattlerb.org/rdoc/RDoc/Markup.htmlは、このページに残っている唯一の有効なリンクです。それを使用するためにあなたの答えを編集しますか?
マークアメリー2014年

回答に記載されているソースコードへのリンクを見つけることができませんでした(これは、「最初の行をクリックしてアクセスしたことを示しています(実際のRDocページで、この回答に含めた引用ではありません)」。Rubyファイルモジュールのソースコード
gene_wood 2015年

23

4
これもかなり最新のように見えます: docs.seattlerb.org/rdoc/RDoc/Markup.html
Steve

3
古いリンクは新しいバージョンで死んでいます。現在: ruby-doc.org/gems/docs/r/rdoc-4.1.2/RDoc/Markup.html
m.silenus 2014

2
これはばかげています。すべてのruby-docリンクが無効になっていますが、これは機能しているようです:ruby-doc.org/stdlib-2.2.3/libdoc/rdoc/rdoc/RDoc/Markup.html しかし、どのくらいの期間...?
ブロンソン2015年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.