[seasar-javadoc:80] Re: ツッコミ大歓迎! 叩き台サンプル

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Mon, 29 May 2006 13:09:18 +0900
From:    "Jundo Ishikawa" <jundo.ishikawa ＠ gmail.com>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:75] Re: ツッコミ大歓迎! 叩き台サンプル

> > Interface=仕様/Class=実装 スタイルの場合、Interfaceの
> > Javadocコメントを書くためには、何か思想的なもの掴む必要が
> > あるのかなぁ…と感じました。
> 
> 　ここは、私も少し悩んでいます。このAccessTypeDefのようなインタフェースの場合、
> それが表すタイプまで書くべきかどうかが悩み所です。タイプを実装の１つとみるか、
> インタフェースにfieldやpropertyという文字列を含む以上、インタフェース上でタイプは
> 定義されていると見るべきか。

そうですね，〜Def は Java5 の enum に近く，事実上そのメンバの
定義も含んでいると考えてよいかと．
ただし，インタフェースが実装クラスに依存しないように，実際の
インスタンスはファクトリ (AccessTypeDefFactory など) 経由で
取得します．
なので，Javadoc 上ではメンバ (AccessTypeDef では FIELD と
PROPERTY) の説明を含んでいいというか，説明があった方が
よいと思います．

> 　Javadocについてですが、内容で少しだけ気になりました。bindの説明で、
> 「DIコンテナ上のオブジェクトグラフに、コンポーネントをバインド」となって
> いますが、「コンポーネントに対してDIコンテナ上のオブジェクトをバインドする」
> のではないでしょうか。

そうですね，オブジェクトグラフ全体を対象としているわけでは
ないので．

> 　実は、ここは私が選んだBindingTypeDefにも絡んでいて、そこのソースを
> 見る限り、ComponentDef, PropertyDefに従って、componentに対して
> バインドする処理だと思いました。是非、ここはコミッタの方に教えていただきたい
> ところです。

はい，コンポーネントが対象でした．
「でした」というのは，先週からプロパティに対しても
BindingTypeDef を指定できるようになったためです．(^^;

> 　コメントのフォーマットについても、１つだけ。@paramの説明は、次の行に
> 書く形で統一しますか？　これは私が変わっているだけという気がしますが、
> 私は同じ行に書いていました。これは、統一できれば良いと思うので、私は
> どちらでも構いません（＾＾；

これもフォーマッタが整形します．
なので，気にしないで Ctrl+Shift+F です．


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