演習 1.2: 構造分析コード・レビューの実行

この演習では、『演習 1.1: 必要なリソースのインポート』を完了していることを想定としています。演習 1.2 では、最初にユーザー・シナリオを読みます。次に、ユーザー・シナリオで説明しているソフトウェア設計者の役割を想定し、演習 1.1 でインポートしたプロジェクトを使用して演習を完了します。



ユーザー・シナリオ

新規に作成したコードを検討して品質を評価するために、設計者が一般的なアンチ・パターンを探す場合があります。アンチ・パターン は、コードに現れるがベスト・プラクティスに従わない既知の問題を指します。設計パターンは従うべきよいモデルですが、アンチ・パターンは避けるべき悪いモデルです。具体的なアンチ・パターンとしては、以下のものがあります。

最初の演習では、設計者がコード・レビューを実行して上記のアンチ・パターンを探します。



演習

この演習では、以下の作業を行います。

  1. 実行するコード・レビューを選択します。
  2. コード・レビューで適用するルールを表示します。
  3. レビューを実行するコードを選択します。
  4. コード・レビューを実行します。
  5. コード・レビューの検出結果を表示します。
  6. 検出結果を選択し、以下の情報を表示します。


コード・レビューの選択

構造分析コード・レビューを選択するには、以下のようにします。

  1. 「コード・レビュー」ビューのツールバーで、「ルールの管理」アイコン をクリックします。
  2. コード・レビュー・ビュー

  3. 「コード・レビューの選択」リストで、「構造分析コード・レビュー」をクリックします。
  4. 「構造分析」フォルダーおよびサブフォルダーを展開し、コード・レビューで適用するルールを表示します (下記参照)。「OK」をクリックします。
  5. 「設定」ウィンドウ



レビューするコード・ベースの選択

レビューするコード・ベースとしてワークスペースを選択するには、以下のようにします。



コード・レビューの実行

レビューするコード・ベースを選択したら、コード・レビューを実行します。ビューの右下隅にある進行状況表示バーを確認すると、状況が分かります。



コード・レビューでの検出結果の表示

コード・レビューが完了すると、「コード・レビュー」ビューに検出結果が表示されます (以下の画面取りを参照してください)。

コード・レビューでの検出結果。縮小表示のフォルダーが 1 つ

「コード・レビュー」ビューには以下の情報が表示されます。



コード・レビューでの検出結果に関する詳細情報の取得

コード・レビューでの検出結果に関する詳細情報を取得するには、以下のようにします。

  1. 「構造分析: 循環依存関係」フォルダーを展開します。4 つの検出結果が表示されます (以下の画面取りを参照してください)。


  2. コード・レビューでの検出結果。展開済みフォルダーが 1 つ

    各検出結果の前には、重大度レベルを示すアイコンが表示されます。

    アイコンの横に電球 () がある場合は、その検出結果に対して即時修正が存在します。即時修正は、特定の検出結果に提供される自動的な解決策です。即時修正アイコンを以下の図に示します。

  3. Event.java で始まる検出結果をダブルクリックします。詳細が 2 箇所に表示されます。概要および画面取りは以下のとおりです。
  4. 選択した検出結果に対するソース・コードと詳細情報

『演習 1.2: 構造分析コード・レビューの実行』は完了です。



コード・レビュー機能の活用

コード・レビューを事前に実行することにより、以下の問題が発生する前に、早期に問題点を特定して訂正できます。

演習 1.4 は、コード・レビューの検出結果を修正することによって演習 1.2 で行った作業に基づいて行います。



演習 1.2 のまとめ

『演習 1.2: 構造分析コード・レビューの実行』は完了です。ここでは、以下の作業を行いました。

  1. 実行するコード・レビューを選択しました。
  2. コード・レビューで適用するルールを表示しました。
  3. レビューを実行するコードの本体を選択しました。
  4. コード・レビューを実行しました。
  5. コード・レビューの検出結果を表示しました。
  6. 検出結果を選択し、以下の情報を表示しました。


演習 1.3: アーキテクチャー制御ルールの定義』に進んでください。

ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2000, 2004. All Rights Reserved.