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

[Hideaki Suzuki]

鈴木(belltree)です。

> initMethodDef/destoryMethodDefの名前
> 　最初にJavadocを書いたときから良い名前が見つからず、今見直すとバラバラの言葉
> が使われています。文脈から変更されているものもあったので、統一するとなると文書
> 自身を若干変更する必要があるかもしれません。
> 
> 　現状：
> 　　initメソッド/destoryメソッド
> 　　initメソッド定義/destoryメソッド定義
> 　　initメソッド・インジェクション/destoryメソッド・インジェクション
> 　　initメソッド・インジェクション定義/destoryメソッド・インジェクション定義
> 　　initMethod/destoryMethod
> 　　initMethodインジェクション/destoryMethdoインジェクション
> 　　初期化メソッド/終了処理メソッド
> 
> 　振り返りでも出ていましたが、「インジェクション」という言葉がついているのは、
> 新しいインジェクション方法が増えてしまっている気がするので、変更したいところ
> ですね。今までに出た案や既に使われている中でよさそうなものを勝手にピックアッ
> プしてみました。
> 
> 　案：
> 　　初期化メソッド定義/終了処理メソッド定義
> 　　initメソッド定義/destoryメソッド定義
> 　　初期化メソッド定義/デストロイメソッド定義
> 　　plologueメソッド/epilogueメソッド
> 
> 　というわけで、どれがよろしいでしょう。私の個人的な意見としては、１つ目か、
> ２つ目あたりがいいかなぁと思いますが。
ちょっとソースを検索したところ、ひがさんがJavadocを書いている
assemblerパッケージの以下のクラスでは、
DefaultInitMethodAssembler ⇒ デフォルトの初期化メソッドアセンブラです。
DefaultDestroyMethodAssembler ⇒ デフォルトの終了メソッドアセンブラです。
となっていました。
なんか、あっさり、しっくりきたのですがいかがですか？
初期化メソッド定義 / 終了メソッド定義 で統一するというのは？

> SMART deployの表現について
> 　現状、各コミッタの間でも表現は統一されていない様子です。カンファレンスの資
> 料でも、HOT deployとHotDeployが出てきます…。なので、とりあえず気にしないとい
> う作戦もありかもしれません。二度と修正できないわけでもないので。
ですね、ちょっとリポジトリにゴミ履歴を残してしまいました…orz
※ deploy ⇒ Deploy ⇒ deploy と修正してしまいました…

> 例外の記述基準
> 　ふりかえりの中で、必要以上に実装を追って例外を記述すると、そのインターフェー
> スの責務を超えてしまうことがあるのではないかという話が出ました。その中で出た
> アイディアとしては、以下の２つでしょうか。
> 
> ・インターフェースに明記されたものだけ記述する。
> ・インターフェースを実装したクラスまでは実装を追って記述する。
S2を使う立場の人が、時によっては、注意して catch する必要のある
例外というのを、選別できれば良いのですが、結構じっくり考えないと
難しいですよね…。ただ、逆に言えば、そういう例外は、非チェック例外
であっても、インターフェースのメソッドのthrows句に記述するべきもの
かなぁとも思うので、ルールとしては、
  ・インターフェースに明記されたものだけ記述する。
が正解のような気がします。
で、ハンドリングが必要な、重要な例外（たぶん非チェック例外）については、
正規コミッターの方に提案して、throws句に追加してもらう方がよいのでは？
と思いました。

> Javadocから公式ドキュメントへのリンク
> 　AOPの説明など、公式ドキュメントを読むのが適切な場合、そこへの参照方法を明示
> したいが、リンクにするか、タイトルの説明だけにするか。
AspectDefのAOPの説明部分を公式ドキュメントへのリンク(AOPの説明ページ)
にしました。万が一リンクが切れた場合でも、"Seasar公式サイト"と書いて、
あるので、きっとGoogleしてくれるという希望的観測に基づいています。
（サイト構成が変わったら、ジャンプページにしてもいいし…）

なにはさておき、junduさん、感謝です！

/** 
 * @auther Hideaki Suzuki
 * @contact suzuki at uinet.or.jp
 */