RDoc

RDoc
原作者	デイブ・トーマス
安定版リリース	5.1.0 / 2017年2月24日 （2017年2月24日）
書かれた	ルビー
オペレーティング·システム	クロスプラットフォーム
タイプ	組み込みドキュメントジェネレータ
ライセンス	GPLv2
Webサイト	ルビー.github .io /rdoc /
リポジトリ	github.com / ruby /rdoc

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マークアップ、Markdown、tomdoc、rdtoolの4つのマークアップ言語をサポートしています。デフォルトでは、RDoc独自のマークアップが使用されます。RDocマークアップでは、特別な指示はコロンで囲まれます。例えば、メソッドが引数 と を取ることを示すにはsite、articleと記述します:args: site, article。^{[ 1 ]}

参照

• ドキュメントジェネレータの比較

参考文献

1. "クラス RDoc::Markup" . rdoc 6.0.4 ドキュメント.

外部リンク

• Ruby Wikibook の RubyDoc に関する章