[seasar-javadoc:360] Re: S2Container

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Thu, 13 Jul 2006 00:28:35 +0900
From:    "Makoto Yonezawa" <stratosphire ＠ gmail.com>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:353] Re: S2Container

> 米澤＠ゆるデスマ中です。

ゆるデスマかぁ．
どうせならホンモノのデスマにしちゃいましょう．
デスマ職人をお貸ししまっせ． (^^;

以下，コメントです．

・register(Object component, String componentName)

>      * 名前を指定してコンポーネントを登録します。

前回の

> > >      * キーを指定してコンポーネントを返します。
> >
> > キーを指定するのは呼び出し側で，コンポーネントを返すのは
> > 呼び出された側です．
> > ココは呼び出された側に統一して，
> >
> >  * 指定されたキーに対応するコンポーネントを返します。
> >
> > みたいな．
> > 他のメソッドも同様で．

と同様で，

 * 指定された名前でコンポーネントを登録します。

にしませう．
コメントの表現は三人称で考えるといいのではないかと．
「私は〜します」でも「あなたは〜します」でもなくて，
「彼は〜します」．
# メソッド名も is〜() とか三人称になるみたいな．一貫してないけど．

register() の場合だと，「彼は，指定された名前で，コンポーネントを
登録します」みたいな．
元の表現だと「彼は，名前を指定して，コンポーネントを登録します」に
なってしまいますが，名前を指定するのは「彼」ではないので変．
「彼」は登録はするけど，名前は指定しない．指定されるのみ．


・register(Class componentClass, String componentName)

>      * 名前を指定してクラスをコンポーネント定義として登録します。

同上．


・registerDescendant(S2Container descendant)

>      * <code>descendant</code>を子コンテナとして登録します。

子コンテナの子コンテナも含むので，「子孫コンテナ」にしませう．

>      * 子コンテナとは、このコンテナに属する子要素のコンテナやその子要素であるコンテナです。

「子要素」というと，XML なんかで

<parent>
  <child/>
</parent>

みたいな場合の <child> のことになるので，ここは

     * 子孫コンテナとは、このコンテナに属する子のコンテナや、その子であるコンテナです。


・include(S2Container child)

>      * 子コンテナをインクルードします。

どっちかというと，

     * コンテナを子としてインクルードします。

がいいかなぁ．


・getChildSize()

>      * インクルードされている子コンテナの数を返します。

「彼は〜」的に

     * インクルードしている子コンテナの数を返します。


・getExternalContextComponentDefRegister()

>      * {@link ExternalContext 外部コンテキスト}が提供する
>      * コンポーネント定義として登録するオブジェクトを返します。

うーん，惜しい．あと少しなんだけど，なかなか難しい．

     * {@link ExternalContext 外部コンテキスト}が提供する
     * コンポーネントを登録するオブジェクトを返します。

でいいかも．
setter も同様．


メソッドのコメントはあと少しですね．
クラスコメントも頑張ってください．(^^;




-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"koichik ＠ improvement.jp"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>