Okapi Project   Web technological site for the beginner... Top

3. 設計書としてのJavaDoc

クラス図、シーケンス図ができたら、各クラスのスケルトンを作成することをお勧めします。

この各クラスのスケルトンでは、メッソッドの定義とコメント(JavaDoc向け)の記述だけを行います。

なぜこのようなことをするかというと、JavaDocを出力するためです。


JavaDocを利用すれば、クラスやメソッドの機能が明確になるだけでなく、カプセル化が正しく行われているかの評価にも使えます。


また、UML作成ツールを使うことで、クラス図からJavaソースコードの自動生成を行えることもできるので、負担になることは無いと思います。