[seasar-javadoc:795] Re: AbstractAnnotationHandler

Koichi Kobayashi koichik @ improvement.jp
2007年 2月 5日 (月) 03:00:42 JST


小林 (koichik) です.

Date:    Sun, 4 Feb 2007 16:42:54 +0900
From:    "Makoto Yonezawa" <stratosphire @ gmail.com>
To:      seasar-javadoc @ ml.seasar.org
Subject: [seasar-javadoc:794] Re: AbstractAnnotationHandler

> ということで、まずは、AnnotationHandler.javaからお願いします。

ありがとうございます.

> で、以下の二つをどういう風に書いていいかわからないので、
> すいませんが、ご教授お願いしますm__m
> externalBinding

ComponentDef では「外部バインディング」ですね.
そのまんま.(^^;

> createPropertyDef

プロパティ定義を作成します,でいいような.

以下,コメントです.

■クラスコメント

>  * コンポーネント定義を作成して返します。

これだけだと寂しいので,もう少し説明を加えたいですね.
AnnotationHandler というのは,コンポーネントクラスに
設定されたアノテーションに従ってコンポーネント定義を
作成します.
それにはコンポーネント名やインスタンス属性,プロパティや
アスペクト,初期化メソッド等の設定を含みます.
といったことをもう少し肉付けして書いてもらえると嬉しいな.

■createComponentDef(String className, InstanceDef instanceDef)

>      * コンポーネント定義を作成します。
>      * クラス名、インスタンス定義を指定して作成する。

なぜに 2 文目がです・ます調じゃない? (^^;
ここは 1 文にしちゃって,

     * クラス名、インスタンス定義を指定して
     * コンポーネント定義を作成します。

という風にした方がよさげ.
他のメソッドも同様ですね.

■appendDI(ComponentDef componentDef)

>      * DIを追加します。

メソッド名を直訳するとこの通りなんですが,これだと見た人が
辛いですね.(^^;

 * コンポーネント定義にプロパティ定義を追加します。

とかなんとか.

■appendAspect(ComponentDef componentDef)

>      * アスペクトを追加します。

もちっと丁寧に

 * コンポーネント定義にアスペクト定義を追加します。

って感じで.
以下同文です.


-- 
<component name="koichik">
    <property name="fullName">"Koichi Kobayashi"</property>
    <property name="email">"koichik @ improvement.jp"</property>
    <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
</component>



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