78


12

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

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

  1. クラスメソッドとそのパラメーターを文書化する方法

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

2 Answer


31


公式のrdocサンプルはhttps://ruby.github.io/rdoc/ExampleRDoc_rdoc.html [こちら]にあり、https://github.com/ruby/rdoc/blob/master/ExampleRDoc.rdoc [GitHubソース]。

rdoc.rubyforge.orgのドキュメントは、http://rdoc.sourceforge.net/doc/index.html [rdoc。 sourceforge.net](付随的に2003年の修正日があります)。

また、Rubyコアとstdlibのドキュメントなど、すばらしいソースがあります。 たとえば、http://ruby-doc.org/core-1.8.7/classes/File.html [File class]のクラスメソッドの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と同様に、サンプルコードをインデントすることにより等幅フォントで表示する方法も示しています。