私は適切なRDoc構文のための良い、しっかりしたリファレンスを探しています。推奨事項?はっきりとわかるものが見つからないようです。
- クラスメソッドとそのパラメータを文書化する方法
- クラスまたはクラスメソッドの機能を文書化する方法。
私は適切なRDoc構文のための良い、しっかりしたリファレンスを探しています。推奨事項?はっきりとわかるものが見つからないようです。
回答:
公式の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と同様に、サンプルコードをインデントして等幅フォントで表示する方法も示しています。
--markup
オプションをサポートしていないようです(rdoc.rubyforge.org/RDoc/Markup.html#label-Supported+でmarkdown
言及されているものを使用しようとしています)フォーマット-何かが足りないのですか?