[seasar-javadoc:102] Re: BindingTypeDef

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Tue, 30 May 2006 01:25:41 +0900
From:    "Jundo Ishikawa" <jundo.ishikawa ＠ gmail.com>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:99]  BindingTypeDef

> 　当面、書き方が統一されてくるまでMLに書いたのを投げる方がよいかと
> 思ったので、私が書いた分も投稿してみます。なにぶん不慣れなので変な
> ところがいっぱいあると思います。ご遠慮なく、ご指摘ください。

お疲れ様です！！
そんなわけで (どんなわけで？)，さっそく．

クラスコメントですが，この場合は <table> を使った表形式より
<dl> を使った説明付きリスト (っていうんでしたっけ？) の方が
HTML になった時に見やすいように思います．
基準を決めるなら，列が 2 コであればテーブルにしないで
説明付きリストにするといったところでしょうか．

その「must」の説明．

> 自動バインディングが適用されない場合、例外が発生します。

「適用されない」は「適用できない」の方がよさげです．
should，may も同様．

「none」の説明．

> autoBinding属性が、auto、propertyの場合でも、

autoBinding 属性が唐突な感じがしますね．
といって，ココで説明を書くのも変なので，

{@link org.seasar.framework.container.BindingTypeDef autoBinding属性}が〜

のように BindingTypeDef へリンクするとよいかも．

getName() メソッドですが，

> バインディングタイプを返します。

@return 同様，

「バインディングタイプの文字列表現を返します。」
                      ^^^^^^^^^^^^
とした方がよいかも．

bind() メソッド．

>      * @param propertyDef
>      *            プロパティ定義
>      * @param propertyDesc
>      *            コンポーネントのプロパティ情報

この二つの区別が分かりにくいのですね．
違いは明白 (矢と的くらい違う) なはずなのに表現しにくい．．．

@param propertyDef
    プロパティに対する設定方法や設定値の定義
@param propertyDesc
    設定対象となるプロパティの情報

．．．
まだまだイマイチかも〜．


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