[seasar-javadoc:507] Re: MetaDefAware

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Tue, 8 Aug 2006 07:43:02 +0900
From:    "Tsuyoshi Yamamoto" <nomadmonad ＠ gmail.com>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:504]  MetaDefAware

> MetaDefAwareを作成いたしました。レビューをお願いします。

ありがとうございます．

出だしですが，

>  * このインターフェースはメタデータの登録・取得方法を定義するオブジェクトを表します。

ここは InitDefAware 風に

 * このインターフェースは、メタデータ定義を登録および取得することができるオブジェクトを表します。

の方がピッタリ来る感じです．
# 見直しフェーズで 〜Def 全体をこの形にしたいかも．

その後の説明は段落を変えませう．
んで，ちょっとだけ直して，

 * <p>
 * メタデータは複数登録することができます。<br>
 * 登録されているメタデータを取得するには、
 * <ul>
 * <li>メタデータ定義名</li>
 * <li>インデックス番号</li>
 * </ul>
 * を指定することが出来ます。
 * </p>

って感じでどうでしょうか．


・getMetaDef(int)

>      * インデックス番号<code>index</code>で指定されたメタデータを返します。
>      * <p>
>      * メタデータ番号は、0, 1, 2…の順に採番されます。
>      * </p>

「メタデータ番号」は他に合わせて「インデックス番号」で．


> ところで、戻り値が配列の場合には
> Javadocにも明示的に書いてあげた方が良かったでしょうか？
> とりあえず今回は、public MetaDef[] getMetaDefs(String name)では
> 「メタデータを取得する」のみ書いたのですが……

個人的には，配列を返すメソッドで一番気になるのは null が
返される可能性があるか内科^h^hないか．
該当するものがない場合に要素数 0 の配列が返されるのか，
null が返ってくるのかはとても気になります．
それは書いてあった方がいいかなぁ．


> # 北海道に住んでるはずなのに
> # 熱帯夜続きってのはどういうことでしょうか……
> # 34℃越えでクーラーのない世界は辛いです……

北海道ってクーラー無いんですか！？
それはまたビックリ．．．
# 逆に沖縄では暖房がないのが普通だったりするのでしょうか？

クーラーなしで 34℃ は辛いなんてものじゃないですね．


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