[seasar-javadoc:110] Re: InstanceDef

Koichi Kobayashi koichik @ improvement.jp
2006年 5月 31日 (水) 00:32:00 JST


小林 (koichik) です.

Date:    Tue, 30 May 2006 23:28:52 +0900
From:    "O.Goto" <o-goto @ try-net.or.jp>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:109]  InstanceDef

> 後藤(goto)です。
> 今日アカウントの承認がおりましたので、覚悟を決めてサインアップをしました。

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

> 今後もこのようにメール添付をした方がよいでしょうか。
> それともコミットして、コミットしたので確認してくださいというメールをした方がよいのでしょうか。

メールベースの方が返答しやすくていいかなぁと思い始めた
今日この頃です.
みなさんがよろしければ,まずはメール上でやりとりして,
ある程度できてから SVN に反映するということにしませんか?


以下は Javadoc へのコメントです.
いきなりどうでもよさげな細かい話で恐縮ですが...

>  * コンポーネントのインスタンスをどのように管理するのかを定義します。diconファイルのcomponentタグのinstance属性に指定します。コンポーネントインスタンス定義の種類は「singleton」、「prototype」、「application」、「request」、「session」、「outer」があります。

この場合の component・singleton・prototype・application・
request・session・outer は <code>〜</code> がよいです.
この後に出てくる <dt>〜</dt> の中なども <code>〜</code>
してください.

application・request・session の説明ですが,

> applicationを使う場合は、<code>{@link 略}</code> を設定する必要があります。

{@link} は <code>〜</code> 不要です.
もっと大事なこととして,ここではサーブレットフィルタの前に
{@link ExternalContext} の設定が必要だということを書いておきたいです.

その後で,「Webコンテナ上で使う場合には、{@link 略}を設定する必要が
あります。」と続ける方向で.

getName() のコメント

>      * コンポーネントインスタンス定義を返します。

「〜定義の文字列表現を返します」で.

ともあれ (JW),インスタンス管理の説明とかしっかりしていて
いい感じだと思います.
この調子で頑張ってください!!


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



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