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

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sat, 05 Aug 2006 18:05:57 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:496]  org/seasar/framework/container/package.html

> org/seasar/framework/container/package.html
> Milestone 1 です。 自信ありません orz
> 
> 容赦ないツッコミをお願いします。 (^^;;;

ありがとうございます．
それでは容赦なく (嘘)．

> このパッケージは、 S2コンテナ自身と、 その要素を定義するインターフェース、
> 及び、S2コンテナの振舞いに関連した例外クラスを含みます。

JDK のドキュメントでも一貫していないわけですが，個人的には
「含みます」より「提供します」がいいかなぁ．

それから，パッケージの説明をしているのは自明なので，出だしの
「このパッケージは」はなくてもいいような．

んで，少しスッキリめに直して

S2コンテナとその構成要素を定義するインターフェースおよび、
S2コンテナの振舞いに関連した例外クラスを提供します。

とかなんとか．

この後ろはもうちょっと頑張りたいですね．
イメージ的には，主要なインタフェースの位置づけを紹介する感じが
いいかなぁ．

S2コンテナを表すのがS2Containerです．．．
S2コンテナに登録されるコンポーネントの定義を表すのが
ComponentDef です．．．

みたいな．


Date:    Mon, 07 Aug 2006 19:51:45 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:498] Re: org/seasar/framework/container/package.html

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

素振り効果？ (^^;
ともあれ (JW)，そもそもが Eclipse のフォーマット対策なので
package.html ではあってもなくてもいいと思います．
書く人がやりやすい方を選んでください．

> > と、package.htmlをmain/resourceに配置するという認識で合っているかどうか
> > でしょうか。
> ここは盲点でした。ローカル環境では、何の疑いもなく main/javaに
> 入れてました。 ^^;;; で、ちょっと考えてみました。

これは src/main/java にしませう．
ActiveMQ が src/main/java なので．
本当は Maven2 に合わせようと思ったのですが，なんか Javadoc
貧弱っぽい．．． package.html は見当たらないし．(^^;

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

せっかく書く以上，Hibernate ほどあっさりしすぎなのは
どうかと思いますが，あまり頑張りすぎないようにしましょう．
詳細はクラス・メソッドの Javadoc で書いているわけなので，
パッケージはその羅針盤というか水先案内人という感じで．



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