Phase3WorkingScheme

第 3 段階では、すべてのエントリのドキュメントを記述します。 質については (あまり) 考えなくて構いません。

作業の手順

まず青木がすべてのドキュメントのエントリに「#@todo」を追加します。 これをすべて消すのが目標です。

作業をするに当たっては、 第 1 段階・第 2 段階と同じくライブラリ単位で担当を分けます。 作業を始めるときは、 まず ASSIGN ファイルのうち担当したいライブラリの行に 自分のアカウントを書き込んでコミットします。 これでそのライブラリの担当になったことにします。

次に、担当になったライブラリのドキュメントをひたすら書きます。 ライブラリ自体のドキュメント、クラスのドキュメント、 メソッドのドキュメントをすべて書いてください。 ドキュメントを書くときは以下のような情報が活用できます。

1. すでに書いてあるドキュメント
2. rdoc (ri で出力できる)
3. ネット上にあるドキュメント
4. メソッドの実際の挙動
5. ソースコード
6. 作者に聞く

ただし、他の人の書いたドキュメントにはそれぞれ著作権があるので、 そのままコピペすることは避けてください。 ただし、再利用が可能なライセンスであると明示的に確認できた場合は そのまま使っても構いません。 それ以外の場合は参考にするに留めましょう。

メソッドのドキュメントを書いたら (またはすでに書いてあったら)、 そのエントリの「#@todo」を消していきます。 一つのライブラリから「#@todo」が完全になくなったら、 ASSIGN ファイルの STATUS 欄を「done」に変えてコミットします。 これでそのファイルの作業は完了です。

参照

• ClassReferenceManualFormat
• HowToWriteMethodEntry