青木です。

ドキュメントでのメタデータの記述方針についていくつか述べます。

(1) ライブラリとクラスの要約文

各ライブラリ／クラスの説明文のうち、第一段落は要約として
扱われます。ライブラリやクラスのインデックスにもその要約
が表示されるので、ドキュメントの第一段落がうまく書いてあ
るとインデックスの価値が高まります。

なお、メソッドについても同様に扱うようにするかもしれません。

(2) ライブラリの作者、alias、copyright

ライブラリの作者、alias、copyright はメタデータとして
記述できるようにします。しかしまだ実装していないので、
とりあえずこれらの情報はライブラリのファイル先頭にコメント (#@#)
で入れておいてください。

(3) クラスの alias

クラスの alias もメタデータとして入れられるようにします。
しかしまだ実装していないのでとりあえず以下同文。


その他、書いているうちに疑問が出てきたら遠慮なくメールを
投げてください。

--
青木峰郎

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/