[seasar-javadoc:203] Re: 【PropertyDef.java】

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Wed, 7 Jun 2006 02:04:45 +0900
From:    きせのん <xenon.0907 ＠ gmail.com>
To:      <seasar-javadoc ＠ ml.seasar.org>
Subject: [seasar-javadoc:201] 【PropertyDef.java】

> 出遅れた格好のXenonです。。。

先は長いので (たぶん)，気にしないでください．

> とりあえず、PropertyDef.javaについて書いてみましたので、
> Javadocレビューをお願いいたしますm(_ _)m

お疲れ様です！！

> PropertyDefはdiconファイルにある<property>要素を
> 取り扱っているクラスのインタフェースであるという認識で記述しています。

はい，その通りです．
PropertyDef が存在する場合は，プロパティインジェクション
あるいはフィールドインジェクションは PropertyDef に従って
行われます．
存在しないければ自動バインディングが行われます (有効な場合)．

以下，Javadoc へのコメントです．

>  * インスタンスまたはクラスのプロパティにインジェクションするプロパティタイプを定義するインタフェースです。
出だしの「インスタンスまたはクラスの」は「コンポーネントの」で
いいかも．
# 鈴木さんのを頂きです．

クラス名が PropertyTypeDef ではなく PropertyDef なので，
「プロパティタイプ」ではなく，「プロパティ定義」にしませう．

getPropertyName() のコメントですが．．．

>      * プロパティタイプの文字列表現を返します。

これはちょっと違います．
このメソッドは設定対象となるプロパティ名を返します．

>      * プロパティタイプの文字列表現とは、diconファイルに記述されている<code>&lt;property&gt;</code>のボディです。

<property> 要素のボディではなく，name 属性に対応します．

>      * 指定されたコンポーネント名をインスタンスまたはクラスのプロパティにインジェクションするものです。

ちょっと意味が分かりませんが，用途は上に書いたように
インジェクション対象となるプロパティまたはフィールドを
特定するためのものです．

>      * バイディングタイプ定義に基づいた<code>{@link BindingTypeDef}</code>を返します。

ここは「バインディングタイプ定義を返します」で十分のような．
なお，{@link 〜} を <code>〜</code> で囲む必要はありません．
@return も書いておいてください．

これ以下のメソッドも同様ということで．



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