Javadoc の書き方 - イトウ アスカ blog

みなさん、Javadoc 書いてますか？ Javadoc は「API ドキュメント」と言われることが多いように、主にライブラリ的なプログラムで書いてこそのものだと思っている方もいるかもしれません。しかしながら、仕様書を Word や Excel（笑）で別途作ると、プログラムと仕様書の同期がとれてないというはめに陥り易くなりますので、Javadoc はどんなときも活用したいというのが私の考え方です。 まず、overview.html を書け Javadoc コメントをいくらか書くような人でも、overview.html を書く人は意外と少ないのではないでしょうか。リファクタリングが何度となく行われるアジャイル開発の現場では、クラスの構成がよくかわりますので、いちいち詳しいコメントを書いていられないということはあるかもしれませんが、overview.html はそれほど何度も手をつけるようなも

[hiyang]

overview.htmlは書かないとな。

[matsukaz]

Javadocの効果的な書き方

[rokujyouhitoma]

そういえば立派にJavadocをかけない...

[Nagise]

package-info.java がEclipseでは作れない問題とかどうなったんだったかな。Classじゃないからnew -> Classで作れないんだけど、ウィザード作るのはオーバースペックじゃないか的な議論がされてたよね

[imai78]

非常に良いマトメ

[flakwing]

overview, package-infoなどとパッケージの分け方も

[hiro_y]

パッケージの分け方の参考に。

[atsushifx]

仕様書として使うためのJavaDocの書き方

[nori0620]

l