[seasar-javadoc:498] Re: org/seasar/framework/container/package.html

[Hideaki Suzuki]

鈴木(belltree)です。

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

> それで、試しに自分なりに書いてみました。
大変参考になります。mOm

> このパッケージは、S2コンテナ自身と、S2コンテナに登録するコンポーネントの
> 定義を表すインターフェース、及びS2コンテナの振る舞いに関連した例外クラス
> を含みます。
〜Def系インターフェースの表現方法については、私も悩みました。
JUNDUさんの表現では 『コンポーネントの定義』 となっていますが、
これは広義の 『コンポーネントの定義』 で、意味としては、コンポーネントと
それに付随する様々な定義という意味ですよね。
こちらの方が直感的には分かりやすいかもしれませんね。う〜む…。
狭義では、たぶん ComponentDef で、こちらを連想する人もいるのかなぁと…
私の表現では、得意の曖昧殺法で(^^;; 『その要素』 としています。
読み返してみると、曖昧な分、ピンときづらいかも…もうちょっと考えてみます ^^;;
ご意見があれば、是非お願いしま〜す。

> S2コンテナに登録するコンポーネントの定義とは、diconファイルや
> Javaソースコードにアノテーションを使って指定された情報のことです。
ここも悩みどころでした…、私は、S2コンテナのインスタンス自体は、
プログラマブルに構築することもできるし、無設定機構を利用した場合は、
個別にdiconファイルに定義を記述したりすることもないので、
 コンポーネントの定義 = { diconファイルの情報 , アノテーションの情報 }
というスタンスは取らずに、一般的なS2利用者が慣れているdiconファイルを
例にして、〜Def系インターフェースの関係を明示しました。
ただ、ここの書き方は自分でも違和感がある部分で、是非いろいろ
削っちゃえば？ということも含め、ご意見を伺いたい部分です。

> 　JavaDoc本文以外で気になったのは、読点の後ろにスペースを含めるかどうか
そうですね。一応、Javadocコメントに合わせて、スペースを入れてみました。
というか、もう、癖になってます。 (^^;;;
package.html については、無いほうがいいですかね？

> と、package.htmlをmain/resourceに配置するという認識で合っているかどうか
> でしょうか。
ここは盲点でした。ローカル環境では、何の疑いもなく main/javaに
入れてました。 ^^;;; で、ちょっと考えてみました。
現在、src/resources で有効なパッケージ(中身が入っている)は、
  (デフォルトパッケージ) … メッセージリソース
  org.seasar.framework.container.factory … DTD
  org.seasar.framework.container.filter … web.xml サンプル
  org.seasar.framework.container.servlet … web.xml サンプル
の4つです。これを見ると、今後 package.html だけのために、パッケージ
フォルダを増やすのは、微妙かなぁと感じます。
なので、個人的には、main/java でいいのかなぁと思います。
mavenスタイルの場合、普通、どっちなのでしょうね？

p.s.
hibernate の org.hibernateパッケージのサマリー
  This package defines the central Hibernate APIs. 
これだけ？ (^^ これに習うと…
  『このパッケージは、S2コンテナの主要なAPIを定義します。』
こんな感じ？ なんか、気が抜けてしもうたです… (^^;;;

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */