[seasar-javadoc:111] Re: AccessTypeDef

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Tue, 30 May 2006 06:14:21 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:106]  AccessTypeDef

> それから、フィールドとプロパティの順番ですが、通常のクラスの記述順に
> 合わせ、「フィールド」 => 「プロパティ」 の順に統一してみました。
> これに伴い、定数定義部分の順番に違和感が出てしまったので、
> FIELD_NAME => PROPERTY_NAME の順番に変えてしまいました。
> もし逆の方が良ければ逆順で統一し直しますので、遠慮なく言って下さい。

プロパティアクセスが標準なので，プロパティ -> フィールドの
方がいい感じですね．
スミマセン．

> ソースとにらめっこをしたり、目を閉じて布団の上で寝ながら考えたりしたのも含め、
> 延べ１０〜１２時間くらいでしょうか？

そ，それは大変でしたね．．．
きっと，鈴木さんのおかげでそれだけの時間を費やさずに
S2 を理解できる人がいるに違いないということで，感謝♪

> ■Javadoc Wiki にgetterとsetterに関する規約を追加しました。
> 表記 > 表記がブレそうな言葉を統一 > *getterとsetter(追加)

ありがとうございます．


以下，修正された Javadoc へのコメント．
ちょっと細かいカモです．

>  * フィールドまたはプロパティへのアクセス方法の定義です。

冒頭，フィールドとプロパティを合わせて一言で「状態」と
表現するのはどうでしょう？
こんな感じ．

 * インスタンスまたはクラスの状態にアクセスする方法の定義です．
 * アクセス方法に基づいて、コンポーネントの状態にコンテナ上のオブジェクトを割り当てる機能も提供します。

すると

>  * アクセスタイプとは、<var>フィールド<var>(インスタンス変数/クラス変数)へのアクセス方法です。

これは不要になって，

> アクセスタイプには「フィールド」アクセスタイプと「プロパティ」アクセスタイプの2種類があります。

ここの「フィールド」は
「<@link org.seasar.framework.container.assembler.FieldAccessTypeDefImpl フィールド}」
とリンクすると便利かも．「プロパティ」も同様．

>  * 「フィールド」アクセスタイプは、<var>フィールド</var>への直接アクセスを表します。

ここで <var>〜</var> を使う必要はないような．

> 「プロパティ」アクセスタイプは、<var>Bean</var>のプロパティ(<var>getter</var>/<var>setter</var>)によるアクセスを表します。

ここの Bean も <var>〜</var> する必要はないような．

>  * このインターフェースを実装したインスタンスは、ファクトリ(AccessTypeDefFactoryなど)経由で取得します。
                                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ここは {@link org.seasar.framework.container.assembler.AccessTypeDefFactory} で．

>  * <code>AccessTypeDef</code>は、<code>{@link PropertyDef}</code>の属性です。

<code>AccessTypeDef</code> はアクセスタイプでいいような．
{@link ...} は <code>〜</code> で囲まなくてもいいです．


定数へのコメント

>      * 「フィールド」アクセスタイプを表す定数です。

>      * 「プロパティ」アクセスタイプを表す定数です。

ここも {@link} しましょう．


getName() のコメント

>      * アクセスタイプ名は、アクセスタイプを表す文字列リテラルです。

返すのは文字列であってリテラルではないので「表す文字列です」で．


どうでもいいことも含まれてるような気のせいがしますが，
こんなところで．


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