[seasar-javadoc:682] Re: KPT org.seasar.framework.container.* 再び

[Jundo Ishikawa]

JUNDUです。

　お疲れさまです。振り返りのときに出た課題について、改めて、メールに書き
ます。ただ、１つ目の課題以外は、今回に間に合わなくていいかなという気もし
ます。

initMethodDef/destoryMethodDefの名前
　最初にJavadocを書いたときから良い名前が見つからず、今見直すとバラバラの言葉
が使われています。文脈から変更されているものもあったので、統一するとなると文書
自身を若干変更する必要があるかもしれません。

　現状：
　　initメソッド/destoryメソッド
　　initメソッド定義/destoryメソッド定義
　　initメソッド・インジェクション/destoryメソッド・インジェクション
　　initメソッド・インジェクション定義/destoryメソッド・インジェクション定義
　　initMethod/destoryMethod
　　initMethodインジェクション/destoryMethdoインジェクション
　　初期化メソッド/終了処理メソッド

　振り返りでも出ていましたが、「インジェクション」という言葉がついているのは、
新しいインジェクション方法が増えてしまっている気がするので、変更したいところ
ですね。今までに出た案や既に使われている中でよさそうなものを勝手にピックアッ
プしてみました。

　案：
　　初期化メソッド定義/終了処理メソッド定義
　　initメソッド定義/destoryメソッド定義
　　初期化メソッド定義/デストロイメソッド定義
　　plologueメソッド/epilogueメソッド

　というわけで、どれがよろしいでしょう。私の個人的な意見としては、１つ目か、
２つ目あたりがいいかなぁと思いますが。


SMART deployの表現について
　現状、各コミッタの間でも表現は統一されていない様子です。カンファレンスの資
料でも、HOT deployとHotDeployが出てきます…。なので、とりあえず気にしないとい
う作戦もありかもしれません。二度と修正できないわけでもないので。

例外の記述基準
　ふりかえりの中で、必要以上に実装を追って例外を記述すると、そのインターフェー
スの責務を超えてしまうことがあるのではないかという話が出ました。その中で出た
アイディアとしては、以下の２つでしょうか。

・インターフェースに明記されたものだけ記述する。
・インターフェースを実装したクラスまでは実装を追って記述する。

Javadocから公式ドキュメントへのリンク
　AOPの説明など、公式ドキュメントを読むのが適切な場合、そこへの参照方法を明示
したいが、リンクにするか、タイトルの説明だけにするか。

　というわけで、課題は、こんなところだったかと思います。


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