[seasar-javadoc:283] Re: InitMethodDef

Matsunobu Yoshinori yoshinori.matsunobu @ gmail.com
2006年 6月 28日 (水) 01:52:54 JST


松信です。

小林さん、コメントありがとうございます。
反映したものを添付致します。

S2Container#injectDependency()の記述でちょっと悩みました。
以下の3種類がありますよね。
・injectDependency(Object outerComponent)
・injectDependency(Object outerComponent, Class componentClass)
・injectDependency(Object outerComponent, String componentName)

自分は、この3つを明示するために、素直に
--
 * コンポーネントインスタンス定義が<code>outer</code>の場合には、{@link
S2Container#injectDependency(Object)}、{@link
S2Container#injectDependency(Object,Class)}、または{@link
S2Container#injectDependency(Object,String)}が呼び出されたタイミングで実行されます。
--
と書いてみました。
が、可読性を考えると、以下のように箇条書きにしても良いかな、とも思います。
--
 * コンポーネントインスタンス定義が<code>outer</code>の場合には、以下のメソッドが呼び出されたタイミングで実行されます。
<dl>
<dt>{@link S2Container#injectDependency(Object)}</dt>
<dt>{@link S2Container#injectDependency(Object,Class)}</dt>
<dt>{@link S2Container#injectDependency(Object,String)}</dt>
</dl>
--

他にも書き方があると思いますが、
どう思われますでしょうか?

以上です。
-------------- next part --------------
テキスト形式以外の添付ファイルを保管しました...
ファイル名: InitMethodDef.java
型:         application/octet-stream
サイズ:     1523 バイト
説明:       無し
URL:        http://ml.seasar.org/archives/seasar-javadoc/attachments/20060628/692e7805/attachment.obj 


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