SeasarJavadocProject

org.seasar.framework.container パッケージのふりかえり†

ふりかえりはＭＬ上では行いづらい部分があるためＷｉｋｉ上でやってみるテスト。

↑

2006.10.29 (Sun) org.seasar.framework.container KPT@赤坂 レポート†

作成中…

↑

クラスコメント†

↑

用語統一†

用語コメント
引数定義
diconファイル
<arg>要素
インジェクション
コンテキスト
S2コンテナ
Expression
コンポーネント定義
アクセスタイプ(AccessTypeDef)⇒アクセスタイプ定義
文字列表現
コンポーネント
状態
インジェクション
アクセスタイプ
ファクトリ
定数
バインディングタイプ定義
プロパティ定義
コンポーネント定義
↑

文書表現統一†

ポイント表現
#getName()のコメント"〜の文字列表現を返します" ⇒ "定義名を返します。"
↑

検討課題†

No課題ステータス検討結果
001日本語・アルファベット混在の場合、括弧は全角で統一する？保留
002<arg>要素、<component>タグ などタグ要素の表現が不統一…保留
003初期化メソッド定義？ initメソッド定義？ ({@link InitMethodDef *})保留【方向性】初期化メソッド定義 にして、ペアとなる DestroyMethodDef の日本語表現を考える…

作業中… Zz… 再開ポイント 15:02:50

↑

修正項目一覧†

場所内容優先度担当者対応済み？備考
全体@authorの後の(Javadoc)を削除する。
package.htmlSmart DeployをSMART Deployに変更する。X
AccessTypeDef/概要サマリされる１文目の後に改行を入れる。
AccessTypeDef/全般アクセスタイプという言葉をアクセスタイプ定義に統一する。
AccessTypeDef#getName()「…文字列表現を返します。」ではなく、「アクセスタイプ定義名を返します。」に修正する。
ArgDef#isValueGettable()「…いずれかが存在する場合、trueを返します。」を「…いずれかが存在し、値の取得が可能かどうかを返します。」といった表現に変更する。合わせて、戻り値の説明を「値の取得が可能な場合、trueを返す」といった表現に修正する。
ArgDefAware#addArgDef登録（追加）を追加に書き換える。
ArgDefAware#getArgDef()他と統一するため、IndexOutOfBoundsExceptionの記述を削除する。
AspectDef/概要S2AOPの後のカッコ内の記述は、Javadocに不要に思われるので削除する。
AspectDef/概要AOP一般に関する記述は、S2Containerの公式ドキュメントに任せ、そちらへの参照先のみとする。リンクにするかどうかは課題。
AspectDef/概要インターセプタを複数登録することと、InterceptorChainを使うことの違いを記述できると良い。
AspectDefAware#addAspectDef登録（追加）を追加に書き換える。
AutoBindingDef/概要サマリされる１文目の後に改行を入れる。
BindingTypeDef/概要サマリされる１文目の後に改行を入れる。
ComponentCreater/概要Smart DeployをSMART Deployに変更する。X
ComponentCustomizer/概要Smart DeployをSMART Deployに変更する。X
ComponentDef/概要インタフェースをインターフェースに統一する。（１行目）
ComponentDef/概要コンストラクタ引数定義は、引数定義に修正する。
ComponentDef#getComponentClass()サマリされる１文目の後に改行を入れる。
ComponentDef#getComponentClass()<component/>を<component>に統一する。
ComponentDeployer/全般コンポーネントインスタンス定義を、インスタンス定義に統一する。
ComponentDeployer/概要インタフェースをインターフェースに統一する。（１行目）
ConstructorAssembler/概要サマリされる１文目の後に改行を入れる。
ConstructorAssembler#assemble()サマリされる１文目の後に改行を入れる。
ContainerConstants#PACKAGE_SEPJavadocの記述が漏れているようです。
DestoroyMethodDef/概要「コンポーネントインスタンス定義」を「インスタンス定義」に統一する。
DestroyMethodAware#addDestoryMethodDef登録（追加）を追加に書き換える。
ExternalContext/概要「Webコンテナなどの外部コンテキスト」に修正してはいかがでしょうか？
ExternalContext#getInitParameterMap()初期化設定値という言葉に違和感を覚えますが、いかがでしょうか？　初期設定値で通じる気がします。
ExternalContext#getRequestHeaderValuesMap()Mapの中身のkeyとvalueが、それぞれ何なのか、決まっているようなら書いてあるとうれしい気がしますが、自明なので不要でしょうか？
ExternalContext#getRequestParameterValuesMap()Mapの中身のkeyとvalueが、それぞれ何なのか、決まっているようなら書いてあるとうれしい気がしますが、自明なので不要でしょうか？
IllegalAccessTypeDefRuntimeException/全体「アクセスタイプ名」を「アクセスタイプ定義名」に統一する。
IllegalAccessTypeDefRuntimeException/コンストラクタアクセスタイプ名をアクセスタイプ定義名に統一する。
IllegalConstructorRuntimeException/概要２行目が「コンポーネントの構築は」で始まっているのは日本語がおかしい。「この例外は」の間違いと思われる。
IllegalMethodRuntimeException/概要「適切な型にパース出来ない場合」は、「適切な型に変換出来ない場合」の方が分かりやすいように個人的には感じるのですが、いかがでしょうか？
InitMehtodDef/概要「１個以上の任意のメソッド」のところは、「１つ以上の任意のメソッド」に変えてみてはいかがでしょうか。個人的にメソッドを１個と数えることに違和感を覚えました。
InitMethodDefAware#addInitMethodDef登録（追加）を追加に書き換える。
InstanceDef/全般「コンポーネントインスタンス定義」を「インスタンス定義」に統一する。
InstanceDef/概要backport175アノテーションに関する記述は削除する。2.4以降でサポートされないため。
InterTypeDef/概要インタフェースをインターフェースに統一する。（１行目、実装インタフェースのところ）
InterTypeDef/概要空の@authorを削除するか、@authorの前に誰かの名前を書いたほうが良いように思います。
InterTypeDefAware/概要インタフェースをインターフェースに統一する。（１行目）
InterTypeDefAware/概要空の@authorを削除するか、@authorの前に誰かの名前を書いたほうが良いように思います。
InterTypeDefAware#addInterTypeDef登録（追加）を追加に書き換える。
MetaDef/概要サマリされる１文目の後に改行を入れる。
MetaDefAware/概要個人的には、メタデータの取得方法の説明は、リストではなく「または」で繋ぐだけでも良い気がします。項目が２つしかないので。
MetaDefAware#getMetaDef(String name)サマリされる１文目の後に改行を入れる。
MetaDefAware#getMetaDefs(String name)サマリされる１文目の後に改行を入れる。
MetaDefAware#getMetaDefs(String name)@param nameが２つ書かれているので、１つ削除する。
MethodDef/概要インタフェースをインターフェースに統一する。（１行目）
PropertyAssembler#assemble例外は、投げるではなくスローに統一する。
PropertyDef/概要インタフェースをインターフェースに統一する。（１行目）
PropertyDefAware/概要インタフェースをインターフェースに統一する。（１行目）
PropertyDefAware#addPropertyDef登録（追加）を追加に書き換える。
PropertyDefAware#hasPropertyDef(String propertyName)ここの説明は、「指定したプロパティ名のプロパティ定義があればtrueを返します。」ではないでしょうか。ちょっと自信ないですが。元の表現と言っている事は同じですか？
TooManyRegistrationComponentDef/概要インタフェースをインターフェースに統一する。（１行目）
トップ   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS