[seasar-javadoc:372] Re: ComponentDeployer

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sat, 15 Jul 2006 13:35:48 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:371] Re: ComponentDeployer

> ○:適切な処理が行われます
> △:例外は発生しませんが何も処理を行いません
> ×:{@link UnsupportedOperationException 例外}が発生します
> としてみました。いかがでしょう?

いいですね．

> ちょっとやってみたのですが、生成したJavadocの
> 「パッケージ org.seasar.framework.container」の「インターフェースの概要」
> を見ると、他の多くのインターフェースは、簡単な説明を含むものが多いので、
> コンポーネントデプロイヤの冒頭説明の濃度が、ちょっと薄くなってしまうかなぁ
> と感じました。
> 個人的には、このページを読むだけで、パッケージ内のインターフェースの
> 責務が、一通り概観できる内容にするのが理想的かなぁと思っています。

なるほど，その通りですね．

> この方向性で、koichikさんのコメントと、非〜Def系のConstructorAssembler
> など、能動的な機能が主な責務のインターフェースを参考に書き直した内容が、
> 以下の文章です。
> 
>  * コンポーネントを利用可能な状態にして提供します。
>  * <p>
>  * このインターフェースはコンポーネントデプロイヤと呼ばれ、 {@link InstanceDef コンポーネントインスタンス定義}に応じて以下の機能を提供します。
> 
> "呼ばれ"とか、かなり微妙かなぁと一瞬思ったのですが、
> 自分の脳ではこれが限界でしゅ…orz

それなら，

 * コンポーネントデプロイヤは、コンポーネントを利用可能な状態にして提供するための
 * インタフェースです。

でどうでしょう？
そうすればその後は

 * <p>
 * コンポーネントデプロイヤは、{@link InstanceDef コンポーネントインスタンス定義}に応じて以下の機能を提供します。

と続けることができます．
と思ったけど，「コンポーネントデプロイヤは、」が続いちゃうのか．．．


> このパッケージのコメントが一通り終わったら、このJavadocの利用者が
> 違和感を覚えないように
>   「全体的な統一感 醸し出しフェーズ」 @_@;;
> を設けた方がいいのかなぁと、ちょいと思ったりしました。

そうですね，是非そうしましょう．

それにしても，package-summary.html を見ると随分と
埋まってきましたね．(^^;
皆さんの頑張りのおかげです．本当にありがとうございます．
引き続きよろしくお願いします．


-- 
<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>