ドキュメント

RDocはDave Thomasによって設計された、Ruby プログラミング言語用の組み込みドキュメント ジェネレータです。Rubyソース コードを解析し、Rubyオブジェクトとメソッドの構造化されたページ コレクションを生成します。コードコメントは自然なスタイルで追加できます。RDoc は Ruby コア ディストリビューションの一部として含まれています。RDoc ソフトウェアと形式は、 Ruby ドキュメント形式(関連ソフトウェア RD 付き)の後継です。

RDoc は、ターゲット ソース コードに明示的なコメントが含まれていない場合でも、クラス、モジュール、メソッドを解析し、生成された API ファイルにリストするため、使用可能なドキュメントを生成できます。RDocは、 Ruby riデータファイルを作成するためのエンジンも提供し、コマンド ラインから API 情報にアクセスできるようにします。

RDoc と ri は現在、Eric Hodel と Ryan Davis によってメンテナンスされています。

RDoc は、RDoc Markup、Markdown、tomdoc、rdtool の 4 つのマークアップ言語をサポートしています。デフォルトでは、独自の RDoc Markup が使用されます。RDoc Markup では、特別なディレクティブはコロンのペアで囲まれます。たとえば、メソッドが および という引数を取ることを示すにはsite、articleと記述します:args: site, article。^[1]

• ドキュメント生成ツールの比較

• Ruby Wikibook の RubyDoc に関する章