[seasar-javadoc:526] Re: S2Container

[Jundo Ishikawa]

JUNDUです。

　お疲れ様です。さすがSeasar2のメインS2Container、すごいボリュームですね。こ
れは書いている最中にどんどん迷子になりそうです。

　クラスの概要は、見出しレベルではよいように思ったので、それ以外の部分で読ん
でみて気になった点についてコメントを付けさせていただきました。推敲の参考にし
ていただければと思います。

■findComponents、findAllComponents、findLocalComponents
　戻り値の説明が長い気がします。キーが文字列か否かで動作が変わるのはパラメー
タか全体の説明のような気がするので、概要側にもっていってはどうでしょうか？
findComponentsに近くなると思います。

　その上で、戻り値の説明は「見つかったコンポーネントの配列。見つからなかった
場合は長さ０の配列を返す。」というのでいかがでしょうか。

■injectDependency(Object outerComponent, Class componentClass)
　同じinjectDependencyでも、これにだけ「クラス名をキーとして、適合するコンポー
ネントを見つけます。」という記述があるのが、ちょっとだけ気になりました。クラ
ス名がcomponentClass.getName()であれば、そういう実装はされていない気もします。

　この１文は無くても問題ないと思うのですがどうでしょう？

■register
　同じメソッド名でコンポーネントとコンポーネント定義の登録があるので、登録さ
れたコンポーネントやコンポーネント定義がどうなるのかが書いてあると、区別が付
けやすく、何のためにあるのかが分かってよいような気がします。

　例えば、register(Object component)であれば、「指定されたオブジェクトを、コ
ンポーネントとしてS2コンテナ上に無名で登録します。登録されたコンポーネント自
身は、インジェクションやアスペクトの適用などは出来ません。ただし、他のコンポー
ネントの構築時に依存オブジェクトとして利用されます。」

# それにしても、registerって同じメソッド名でコンポーネントを登録したりコンポー
# ネント定義を登録したりと紛らわしいのですね(^^;;

■findComponentDefs、findAllComponentDefs、findLocalComponentDefs
　findComponentsと同じで、戻り値の説明の一部を概要側に移したほうがよい気がし
ます。

■その他全般
　find〜系が対象とするS2コンテナの範囲が難しいため、他のメソッドも対象範囲が
分からなくなってきました。そのため、例えばfind〜系の範囲だけが特殊であればク
ラスがいよう部分に一般的な範囲とfind〜系だけが特殊であることを、メソッドごと
に範囲のバラツキが大きいようであれば全てのメソッドの説明に対象となるS2コンテ
ナを記述するとよいと思いました。

　以上、余りソースを呼んでいない状態でドキュメントを読んで、気になった点を書
いてみました。

　横綱級のS2Container、大変だとは思いますがあと少しです。飲み会目指して(?)、
がんばりましょう(^^)


06/08/28 に Makoto Yonezawa<stratosphire ＠ gmail.com> さんは書きました:
> 米澤です。
> またあいてしまいました・・・
> 仕事もあと少しです。
> ご迷惑をおかけしてすいませんですm__m
> まずは、メソッドコメントをすべて書いたものを添付します。
>
> 長いですが、確認お願いします。
（以下、省略）


-- 
 Jundo Ishikawa <jundo.ishikawa ＠ gmail.com>