SeasarJavadocProject/org.seasar.framework.container/KPT

Javadocコメントの振り返り 【読む目的 x 記載内容】

  • 読む目的とあるとうれしい記載内容の関係
    記載内容\読む目的☆一部の機能を使いたい☆機能を拡張したいトラブルの原因調査理解を深めたい使い方を知りたい
    コードサンプル
    拡張ポイント
    拡張時の注意点
    実装クラスの解説
    大まかな構成
    メソッドの処理概要
    例外と可能性の高い発生原因
    クラスの関連図
    クラスの関連説明
    Diconファイルとソースの関連
    S2のドキュメントとソース関連

Javadocコメントの振り返り 【パターン別統一ポイント】

  • 記述内容の検証ポイント
    • 処理記述について
      • 「(どうやるかではなく)何をするか」という記述になっているか?(特にインターフェース)
  • 全般
    • 統一ポイント
  • 〜Def系
    • 統一ポイント
    • 修正ポイント
      クラス/インターフェース_________________修正ポイント________________________________________
      AccessTypeDef
      ArgDef
      AspectDef
      AutoBindingDef
      BindingTypeDef
      ComponentDef
      InstanceDef
      InterTypeDef
      MetaDef
      MethodDef
      PropertyDef
      InitMethodDef
      DestroyMethodDef
      TooManyRegistrationComponentDef
  • 〜Aware系
    • 統一ポイント
    • 修正ポイント
      クラス/インターフェース_________________修正ポイント________________________________________
      ArgDefAware
      AspectDefAware
      DestroyMethodDefAware
      InitMethodDefAware
      InterTypeDefAware
      MetaDefAware
      PropertyDefAware
  • コンポーネント組み立て系
    • 統一ポイント
    • 修正ポイント
      クラス/インターフェース_________________修正ポイント________________________________________
      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
Last-modified: 2006-10-31 (火) 00:28:56 (5033d)