[seasar-javadoc:213] Re: ExternalContext

Koichi Kobayashi koichik @ improvement.jp
2006年 6月 12日 (月) 00:00:30 JST


小林 (koichik) です.

Date:    Sun, 11 Jun 2006 22:35:50 +0900
From:    "O.Goto" <o-goto @ try-net.or.jp>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:211]  ExternalContext

> 後藤(goto)です。
> 
> ExternalContextのレビューお願いします。

ExternalContext はちょうど変更が入ったところですが,
作業が二度手間になったりしなかったでしょうか?

>  * S2コンテナ上で、 WEBコンテナなどのコンテキストを扱うためのインターフェースです。 {@link java.util.Map}インターフェースで、
>  * コンテナに依存することなくコンテキストへのアクセスができます。

この「コンテナ」は Web コンテナのことですが,S2Container と
紛らわしいかもしれません.
一応,S2Container は S2 コンテナと表記してはいるわけですが.
っていうか,Map 云々はクラスコメントとしては必要ないような
気のせいもします.
それよりも InstanceDef との関連を書いた方がよさそう.
一応 @see を書いて頂いてますが.

>      * アプリケーションコンテキストを{@link java.util.Map}インターフェースで提供します。

たぶんに好みの問題 (つまり,これでも悪くない) ですが,
最後は「提供します」より「返します」が好きかなぁ.

あと,InstanceDef#APPLICATION_NAME と,まだ Javadoc はありませんが
org.seasar.framework.container.deployer.InstanceApplicationDef を
@see しておきましょう.

他のメソッドも同様で.



-- 
<signature>
    <name>Koichi Kobayashi</name>
    <e-mail>koichik @ improvement.jp</e-mail>
</signature>



seasar-javadoc メーリングリストの案内