Javadoc が書きづらい

 Cubby で書いた Web アプリケーションの Javadoc 用のコメントを整備してるんですが、DI を使うと必然的に Setter が増えると思うんですよ。public フィールドでもいいんですけど。

 それで、public と protected のメソッドとフィールドには必ず Javadoc コメントをつけることにしてるんですが、この DI のための Setter のためにやたらと同じような Javadoc コメントを書くはめになっているんですね。すごく非効率的だなって思うんです。ほとんど、定型文をコピペしてるんですけどね。

 もちろん、利点もあるんです。どういう Service を使っているかなんてことが Setter を見ればわかりますからね。でも、Setter はあるから使っていることが保証されるわけではないですからねぇ。

 いっそ、DI コンテナの Setter だけを共通のスーパークラスにもって、DI コンテナだけインジェクションさせて、そのコンテナから中でコンポーネントを取り出したほうがいいんじゃないかとすら思います。


 それから、Javadoc って JavaBeans 仕様は考慮しないじゃないですか。Setter も Getter も普通のメソッドとしてずらずらならべるだけ。なので、画面項目が多くなってくると Action クラスとかの Javadoc がホントに苦痛。

 その点 Wicket なら、画面項目というのはクラスの仕様ではなく、オブジェクトの仕様なので、画面項目とメソッドの数は必ずしも一致しない。その分、フリーフォーマットでクラスのコメントとしてしっかりと書いとけばいいんじゃないかと思うんですね。



 ということで、私のようにわりと生真面目に Javadoc を書く人のためにドキュメンテーションも考慮されたフレームワークがあるといいなと思います。自分で doclet 作れば?って話もあるでしょうが。