[seasar-javadoc:856] Re: ConstantAnnotationHandler

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Wed, 18 Apr 2007 20:28:33 +0900
From:    Maeno <[E-MAIL ADDRESS DELETED]>
To:      [E-MAIL ADDRESS DELETED]
Subject: [seasar-javadoc:855] Re: ConstantAnnotationHandler

> 遅くなって申し訳ありません・・・・。

こちらこそ返信遅れて申し訳ありません．m(__)m

> ConstantAnnotationHandlerのjavadocレビューをよろしくお願いいたします。

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

> 結構右往左往してます....orz
> 
> #最初の頃に書いてたjavadocとはかなり違っています・・・(^^;

気にしない気にしない．(^^;


■クラスコメント

>  * クラスに指定された定数アノテーションからコンポーネント定義を作成する実装クラスです。
>  * <p>
>  * 定数アノテーションとは<code>public</code>,<code>static</code>,<code>final</code>を用いて記述されたフィールドの事です。
>  * </p>

いいですね．

>  * <h4>Componentアノテーション</h4>
>  * <p>
>  * 指定されたコンポーネントクラスのフィールドに<code>COMPONENT</code>アノテーションがある時、
>  * 定数アノテーションに記述されている文字列を解析し、<code>name</code>,<code>instance</code>,<code>autoBinding</code>,<code>externalBinding</code>それぞれ属性の値を
>  * 取得してコンポーネント定義を作成します。 規定された属性以外の属性が書き込まれた場合は{@throws IllegalArgumentException}をスローします。
>  * </p>

ここらへんの書き方ですが，

 * <code>COMPONENT</code>アノテーションは、フィールド名が<code>COMPONENT</code>で
 * <code>String</code>型のフィールドです。
 * フィールドの値は次の形式で指定します。
 * <pre>
 * <var>key1</var>=<var>value1</var>, <var>key</var>=<var>value2</var>, ...
 * </pre>
 * キーとその値は次のものを指定することができます。
 * <dl>
 * <dt><code>name</code></dt>
 * <dd>コンポーネント名</dd>
 * ...
 * </dl>
 * フィールドの値が不正な場合は{@link IllegalArgumentException}をスローします。

みたいにした方がスッキリじゃないかと思うのですが
どうでしょう？

■isConstantAnnotationField(Field field)

>      * @return フィールドが定数アノテーションであれば<code>true</code>,無ければ<code>false</code>

「無ければ」は「なければ」ですね．
っていうか，「〜の場合はtrue、そうでない場合はfalse」が
好きかも．

■appendAspect(ComponentDef componentDef, String interceptor, String pointcut)

コメントの本文で例外を説明した場合って，@throws は付けないことに
なってたのでしたっけ？
実行時例外でも @throws に書いていいと思うのですが．





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