[seasar-javadoc:124] Re: InstanceDef

[Jundo Ishikawa]

JUNDUです。

06/05/30 に O.Goto<o-goto ＠ try-net.or.jp> さんは書きました:
> 後藤(goto)です。
> 今日アカウントの承認がおりましたので、覚悟を決めてサインアップをしました。

　お疲れ様です。お互い、頑張っていきましょう(^^)

> 早速ですがツッコミをお願いします。

　はい、ちょっと細かな内容になっていそうですが気になった点を書いてみます。

まずクラス定義のコメントですが、
> * diconファイルのcomponentタグのinstance属性に指定します。

　現在はアノテーションによる指定ができることと、何となくインタフェースの
コメントに書く内容かどうか個人的に微妙なところと感じてしまいました。確かに
イメージは付きやすくなるのですよね。

　書くなら、ComponentDefをはじめとしたコンポーネント定義類のJavadocでは
合わせた方が統一感が出る気がします。

> * <dt>singleton(default)</dt>

　このdefaultを書くべきかどうかも悩みどころだと感じています。ここも書く
のであれば、合わせた方が良いと思います。(BindingTypeDefでは省略してしまい
ました(^^;

それから、createComponentDeployerのコメントで
> * コンポーネントインスタンス定義に基づいた<code>{@link ComponentDeployer}</code>を返します。

　ここでは、引数のComponentDefが何に使われているのかの説明も欲しい気が
します。例えば、

* コンポーネントインスタンス定義に基づいた<code>componentDef</code>のインスタンスを取得するための<code>{@link
ComponentDeployer}</code>を返します。

　ちょっと日本語がいまいちですが、こんな感じではいかがでしょうか。

　Javadocについて気になったのは以上です。

> 今後もこのようにメール添付をした方がよいでしょうか。
> それともコミットして、コミットしたので確認してくださいというメールをした方がよいのでしょうか。

　私は、少なくとも当面はメールで意識を合わせていく進め方が良いと思います。
その方が、きっと書き方もそろえやすい気がするので。


-- 
 Jundo Ishikawa <jundo.ishikawa ＠ gmail.com>