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

Jundo Ishikawa jundo.ishikawa @ gmail.com
2006年 5月 29日 (月) 13:09:18 JST


JUNDUです。

06/05/29 に Hideaki Suzuki<suzuki @ uinet.or.jp> さんは書きました:
(引用一部省略)
> Interface=仕様/Class=実装 スタイルの場合、Interfaceの
> Javadocコメントを書くためには、何か思想的なもの掴む必要が
> あるのかなぁ…と感じました。

 ここは、私も少し悩んでいます。このAccessTypeDefのようなインタフェースの場合、
それが表すタイプまで書くべきかどうかが悩み所です。タイプを実装の1つとみるか、
インタフェースにfieldやpropertyという文字列を含む以上、インタフェース上でタイプは
定義されていると見るべきか。

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

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

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

 以上、勝手なことばかり書いて申し訳ございません。


seasar-javadoc メーリングリストの案内