[seasar-javadoc:228] Re: ConstructorAssembler
Koichi Kobayashi
koichik @ improvement.jp
2006年 6月 15日 (木) 02:30:31 JST
小林 (koichik) です.
Date: Wed, 14 Jun 2006 00:28:45 +0900
From: "Jundo Ishikawa" <jundo.ishikawa @ gmail.com>
To: seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:224] ConstructorAssembler
> 週末少しバタバタして遅れてましたが、なんとかConstructorAssemblerの
> Javadocを書いてみました。
ありがとうございます.
クラスコメントですが,
> * このインターフェースを実装するクラスは、 コンストラクタ・インジェクションを実行してコンポーネントを返す機能を提供します。
実装クラスの説明っぽく見えるのはちょっと避けたいな,と.
ここではこのインタフェースそのものの概念や役割を書きませう.
ConstructorAssembler や PropertyAssembler など,
〜Assembler というのは,文字通りコンポーネントを
組み立てることを目的としています.
「組み立てる」というのは,コンストラクタを実行するという
だけでなく,必要ならその引数に渡すためのコンポーネントを
集めてくるということも含みます.
なので,例えば冒頭は
* コンストラクタ・インジェクションを実行してコンポーネントを
* 組み立てます.
って感じとか.
> あと、書いていて、throws句に明示的に書かれていない例外のコメントを
> どうするかが気になりました。書かない、実装クラス側に書く、仕様として
> 書くべきであればインターフェース側に書くといった選択肢がありそうですが、
> どれにしましょうか。とりあえず、今回はインターフェースに書いて見ました。
throws 節には checked 例外しか書いていませんが,Javadoc 的には
unchecked な例外も書きたいですね.
事実上,仕様みたいな例外も多いですから.
そんなわけで (どんなわけで?),できるだけ実装クラスがスロー
している例外を探してきて,インタフェースの方の @throws に
書いていく方向で.
ただし,明示的にスローしているものだけでいいです.
ヌルポとかスローされる可能性を追求する必要はないと
いうことで.(^^;
--
<signature>
<name>Koichi Kobayashi</name>
<e-mail>koichik @ improvement.jp</e-mail>
</signature>
seasar-javadoc メーリングリストの案内