[seasar-javadoc:371] Re: ComponentDeployer

[Hideaki Suzuki]

鈴木(belltree)です。

koichikさんコメントありがとうございます。mOm


> > ○ 有効(処理あり)
> > △ 有効(処理なし)
> > × 無効(例外)
> > という色分けで表を調整してみました。いかがでしょう?
> 
> よさげです．
> あと，「処理あり」「処理なし」の説明を簡単にした方がいいかも．
○:適切な処理が行われます
△:例外は発生しませんが何も処理を行いません
×:{@link UnsupportedOperationException 例外}が発生します
としてみました。いかがでしょう?


> >  * このインターフェースは、 コンポーネントを利用可能にするための機能を提供するコンポーネントデプロイヤを表します。
> 
> どうせ「コンポーネントデプロイヤ」って言葉を使うなら，いっそのこと
> 
>  * コンポーネントデプロイヤのインタフェースです。
>  * <p>
>  * コンポーネントデプロイヤとは、コンポーネントを利用可能にして提供するもので、
>  * {@link InstanceDef コンポーネントインスタンス定義}に応じて以下の機能を提供します。
> 
> とかどうでしょう？
ちょっとやってみたのですが、生成したJavadocの
「パッケージ org.seasar.framework.container」の「インターフェースの概要」
を見ると、他の多くのインターフェースは、簡単な説明を含むものが多いので、
コンポーネントデプロイヤの冒頭説明の濃度が、ちょっと薄くなってしまうかなぁ
と感じました。
個人的には、このページを読むだけで、パッケージ内のインターフェースの
責務が、一通り概観できる内容にするのが理想的かなぁと思っています。

この方向性で、koichikさんのコメントと、非〜Def系のConstructorAssembler
など、能動的な機能が主な責務のインターフェースを参考に書き直した内容が、
以下の文章です。

 * コンポーネントを利用可能な状態にして提供します。
 * <p>
 * このインターフェースはコンポーネントデプロイヤと呼ばれ、 {@link InstanceDef コンポーネントインスタンス定義}に応じて以下の機能を提供します。

"呼ばれ"とか、かなり微妙かなぁと一瞬思ったのですが、
自分の脳ではこれが限界でしゅ…orz

もし、やっぱり元の文章(koichikさんのコメントの文章)の方が良いということ
であれば、修正しますので遠慮なく言って下さい。 (^^

p.s.
ついつい、各クラスやインターフェースの中だけの整合性を考えてしまいますが、
(S2を勉強しながらなので、なかなか余裕もないし… ^^;;;;;;;)
Javadocで生成されるCompositionなページも要チェックですね。
このパッケージのコメントが一通り終わったら、このJavadocの利用者が
違和感を覚えないように
  「全体的な統一感 醸し出しフェーズ」 @_@;;
を設けた方がいいのかなぁと、ちょいと思ったりしました。
次のパッケージの作業とConcurrentで進めてもいいですし (^^

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ComponentDeployer.zip
Type: application/x-zip-compressed
Size: 7741 bytes
Desc: not available
Url : http://ml.seasar.org/archives/seasar-javadoc/attachments/20060715/055c33f7/attachment.bin 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ComponentDeployer.java
Type: application/octet-stream
Size: 7821 bytes
Desc: not available
Url : http://ml.seasar.org/archives/seasar-javadoc/attachments/20060715/055c33f7/attachment.obj