[[SeasarJavadocProject]]
*org.seasar.framework.container パッケージのふりかえり [#hadc6c81]

ふりかえりはML上では行いづらい部分があるためWiki上でやってみるテスト。

**org.seasar.framework.container KPT@赤坂 レポート [#h7f74ed7]
**2006.10.29 (Sun) org.seasar.framework.container KPT@赤坂 レポート [#h7f74ed7]
作成中…

**Javadocコメントの振り返り 【読む目的 x 記載内容】 [#r109a47d]
-読む目的とあるとうれしい記載内容の関係
|~記載内容\読む目的|~☆一部の機能を使いたい|~☆機能を拡張したい|~トラブルの原因調査|~理解を深めたい|~使い方を知りたい|
|~コードサンプル||||||
|~拡張ポイント||||||
|~拡張時の注意点||||||
|~実装クラスの解説||||||
|~大まかな構成||||||
|~メソッドの処理概要||||||
|~例外と可能性の高い発生原因||||||
|~クラスの関連図||||||
|~クラスの関連説明||||||
|~Diconファイルとソースの関連||||||
|~S2のドキュメントとソース関連||||||
***クラスコメント [#m6d95d8b]
--クラスコメントの先頭行は句点(。)まで改行しない。
--2行目(2文目)以降については<p>タグで括る。
--HTMLタグは小文字で記述する。
--@author タグの "(Javadoc)" は除く(そして気を引き締める (^^;))。ex. @author hoge (Javadoc) ⇒ @author hoge

***Javadocコメントの振り返り 【パターン別統一ポイント】 [#p19fd84d]
-記述内容の検証ポイント
--処理記述について
---「(どうやるかではなく)何をするか」という記述になっているか?(特にインターフェース)
-全般
--統一ポイント
***用語統一 [#mbbbdbdd]
|用語|コメント|
|引数定義||
|diconファイル||
|<arg>要素||
|インジェクション||
|コンテキスト||
|S2コンテナ||
|Expression||
|コンポーネント定義||
|アクセスタイプ(AccessTypeDef)|⇒アクセスタイプ定義|
|文字列表現||
|コンポーネント||
|状態||
|インジェクション||
|アクセスタイプ||
|ファクトリ||
|定数||
|バインディングタイプ定義||
|プロパティ定義||
|コンポーネント定義||

**文書表現統一 [#j3b26c6c]
|ポイント|表現|
|#getName()のコメント|"〜の文字列表現を返します" ⇒ "定義名を返します。"|
|||

-〜Def系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|AccessTypeDef||
|ArgDef||
|AspectDef||
|AutoBindingDef||
|BindingTypeDef||
|ComponentDef||
|InstanceDef||
|InterTypeDef||
|MetaDef||
|MethodDef||
|PropertyDef||
|InitMethodDef||
|DestroyMethodDef||
|TooManyRegistrationComponentDef||
**検討課題 [#a4af7a0b]
|No|課題|ステータス|検討結果|
|001|日本語・アルファベット混在の場合、括弧は全角で統一する?|保留||
|002|<arg>要素、<component>タグ などタグ要素の表現が不統一…|保留||
|003|初期化メソッド定義? initメソッド定義? ({@link InitMethodDef *})|保留|【方向性】初期化メソッド定義 にして、ペアとなる DestroyMethodDef の日本語表現を考える…|

-〜Aware系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|ArgDefAware||
|AspectDefAware||
|DestroyMethodDefAware||
|InitMethodDefAware||
|InterTypeDefAware||
|MetaDefAware||
|PropertyDefAware||
作業中… Zz…
再開ポイント 15:02:50

-コンポーネント組み立て系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|ConstructorAssembler||
|MethodAssembler||
|PropertyAssembler||

-〜DefRuntimeException系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|IllegalAccessTypeDefRuntimeException||
|IllegalAutoBindingDefRuntimeException||
|IllegalBindingTypeDefRuntimeException||
|IllegalInstanceDefRuntimeException||

-指定によるコンポーネント組み立て失敗例外系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|IllegalConstructorRuntimeException||
|IllegalAutoBindingPropertyRuntimeException||
|IllegalMethodRuntimeException||

-アノテーション不正例外系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|IllegalInitMethodAnnotationRuntimeException||
|IllegalDestroyMethodAnnotationRuntimeException||

-その他の例外系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|ClassUnmatchRuntimeException||
|ComponentNotFoundRuntimeException||
|ContainerNotRegisteredRuntimeException||
|CyclicReferenceRuntimeException||
|ExtensionNotFoundRuntimeException||
|TooManyRegistrationRuntimeException||

-定数定義系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|ContainerConstants||

-大物系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|S2Container||

-外部コンテキスト系
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|ExternalContext||
|ExternalContextComponentDefRegister||

-その他(未分類)
--統一ポイント
--修正ポイント
|~クラス/インターフェース_________________|~修正ポイント________________________________________|
|Expression||
|ComponentDeployer||


トップ   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS