[seasar-javadoc:885] Re: [AbstractAnnotationHandler]

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Mon, 21 May 2007 21:30:01 +0900
From:    "Makoto Yonezawa" <[E-MAIL ADDRESS DELETED]>
To:      [E-MAIL ADDRESS DELETED]
Subject: [seasar-javadoc:882]  [AbstractAnnotationHandler]

> またまた、ずいぶんあけてしまってすいません。
> ということで、本当の？[AbstractAnnotationHandler]です。

本当の？
偽物があったんでしたっけ？(^^;

> だいたいはかいたんですが、
> abstractのときのクラスコメントはどんなかんじにすればいいのでしょうか？

出だしは「〜の抽象クラスです」とかで始めて，
サブクラスに対して何を提供するかを書けばよいかと．
AnnotationHandler はクラスやメソッド，それに
フィールドからアノテーションを読み取る部分と，
それに従ってコンポーネント定義その他を組み立てる
部分があって，このクラスは後者の方を提供する
わけですね．
で，アノテーションを読み取る部分はサブクラスの
役割，と．
そんなことを書けばいいんじゃないかなぁ．

以下，コメントです．

■createComponentDef(String, InstanceDef) 等

(non-Javadoc) なコメントは不要です．
インタフェースで定義されてるメソッドについては
コメントは一切無しということで．

■getInstanceDef(String, InstanceDef) 等

最初の文の後は <br> ではなく <p>〜</p> で段落を
区切ってください．

■isFieldInjectionTarget(Field)

>      * staticかまたは、Finalでない場合はインジェクションが可能になります。

Final -> final で．
こういうキーワードは，できれば <code>〜</code> で．


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