rgss-lib コメント規約
Last update : 2005/12/06 目次 １．はじめに ２．コメントの挿入箇所について ３．コメントの書き方 ３．１．ファイルヘッダ ３．２．クラス/モジュールヘッダ ３．３．メソッドヘッダ ３．４．ネームスペース、定数、クラス/モジュール変数 ３．５．プロパティ ３．６．定義変更メソッドについて ４．アウトライン ５．RDocの使用方法 更新履歴 2005/12/06 和希 第１版発行 2005/12/03 和希 新規作成 １．はじめに rgss-libではRDocスタイルにてコメントを記述しています。 RDocスタイルではクラス、モジュール、関数などについて指定された書式の コメントをHTMLなどで出力し、APIリファレンス化することが出来ます。 → Java/C++なんかのDoxygenに近いです。 詳しくはこちら(公式・英語)をご覧ください。 ２．コメントの挿入箇所に
RDoc Documentation
RDOC - Ruby Documentation System このパッケージはRdocとSimpleMarkupというふたつのコンポーネントを含んでいます。 RdocとはRubyのソースファイルに対するドキュメントを生成するアプリケーションです。 JavaDocと同様に、ソースを解析し、クラス、モジュール、メソッドの定義を抜き出して きます(include,requireもです)。そしてこれらの内容とその直前に書かれた コメントを併合し、ドキュメントを出力します(現在はHTMLしか出力できませんが 、この部分は取り替え可能にできています)。Markupとはプレーンテキストを 様々なフォーマットに変換するためのライブラリです。Rdocによってメソッドや クラスに関するドキュメントを生成するとき、コメント部を変換するため に使われます。 ロードマップ RdocでRubyのソースファイルに対
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
RDoc Documentation