[seasar-javadoc:961] Re: AbstractS2ContainerBuilder

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Sun, 8 Jul 2007 17:25:50 +0900
From:    "Naoki Sega" <[E-MAIL ADDRESS DELETED]>
To:      [E-MAIL ADDRESS DELETED]
Subject: [seasar-javadoc:958] Re: AbstractS2ContainerBuilder

> AbstractS2ContainerBuilderを小林さんの指摘を踏まえ、
> 修正いたしましたので、確認をよろしくお願いします。

ありがとうございます！！

> JavaDocの書き方をあまりにも理解できていなかったのが、
> 恥ずかしい限りです。
> 内容より、書き方に戸惑っておりました。

最初はみんな同じだと思いますよ．
自分の場合，悩んだら JDK の Javadoc を見るように
してます．
もっとも，JDK の Javadoc も結構不揃いですが．(^^;
書籍だと，「プログラミング言語 Java」にそこそこの
解説があります．
他では洋書ですが，「The Elements of Java Style」という
書籍にああしろ，こうしろ的なことが書いてあります．
まぁ，この本を買うほどのことはないと思いますが．

ともあれ (JW)，AbstractS2ContainerBuilder の Javadoc ですが，
最後の getInputStream(final String path) メソッドの中で
ResourceNotFoundRuntimeException をスローしているので，
@throws を追加してください．
それだけお願いします．

> 最新版をリポジトリから更新したら、
> ひがさんのコメントつきのAbstractS2ContainerBuilderが
> 更新されたのですが、
> 今回のソースは、チェックインは見送ったほうがよいのでしょうか？

ひがさんのレス通り，上書きしてコミットということで．
ひがさんの方ではとりあえず Javadoc を埋めることを目的に
しているので，内容は必要最低限というか簡素なものに
なっています．
Javadoc チームの方では，Javadoc 見る人の役に立つ情報を
上乗せしていきたいと考えています．


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"[E-MAIL ADDRESS DELETED]"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>