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

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



ユーザー・シナリオ

設計者が作成された最新のコードをレビューし、コードの品質を評価するには、一般的なアンチパターンを見つけます。 アンチパターン は、コードで発生し、ベスト・プラクティスに従わない既知の問題です。 設計パターンが従うべき優良なモデルであるのに対し、アンチパターンは回避すべき粗悪なモデルです。以下のタイプの、いくつかの特定のアンチパターンがあります。

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



演習

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

  1. 実行するコード・レビューを選択する。
  2. コード・レビューに適用されているルールを表示する。
  3. レビューを実行するコードを選択する。
  4. コード・レビューを実行する。
  5. コード・レビューの検出結果を表示する。
  6. 検出結果を選択し、その検出結果についての以下の情報を確認する。


コード・レビューの選択

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

  1. 「コード・レビュー (Code Review)」ビューのツールバーで、「ルールの管理 (Manage Rules)」アイコン、をクリックする。
  2. コード・レビュー・ビュー

  3. 「コード・レビューの選択 (Select Code Review)」リストで、「構造分析コード・レビュー (Structural Analysis Code Review)」をクリックする。
  4. 以下に示されているように、「構造分析 (Structural Analysis)」 フォルダーおよびサブフォルダーを展開し、コード・レビューで適用されるルールを確認する。 「OK」をクリックします。
  5. 設定ウィンドウ



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

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



コード・レビューの実行

レビューを実行するコード・ベースを選択した後で、コード・レビューを実行します。 ビューの右下隅にある進行状況表示バーを確認することで、状況を追跡できます。



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

以下の画面取りに示されているように、コード・レビューが終了すると、「コード・レビュー (Code Review)」ビューに検出結果が表示されます。

コード・レビュー検出結果、1 つの折りたたまれたフォルダー

以下の情報が、「コード・レビュー (Code Review)」ビューに表示されます。



コード・レビュー検出結果の詳細情報の取得

コード・レビューの検出結果の詳細情報を取得するには、以下の手順を実行します。

  1. 「構造分析: 循環依存関係 (Structural Analysis: Cyclic Dependency)」フォルダーを展開する。 以下の画面取りに示されているように、4 つの検索結果があります。


  2. コード・レビュー検索結果、1 つの展開されたフォルダー

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

    アイコンの横に電球がある場合は ()、検出結果にクイック・フィックスが存在することを示します。 クイック・フィックスは、特定の検出結果のための、提供されている自動解決機能です。クイック・フィックス・アイコンは、以下の図に示されています。

  3. Event.java で開始する検出結果をダブルクリックする。 以下の要点と画面取りに概要が示されているように、検出結果の詳細が、2 つの場所にあります。
  4. 選択された検出結果のソース・コードと詳細情報

『演習 1.2: 構造分析コード・レビューの実行』が完了しました。



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

コード・レビューを積極的に実行することで問題を早期に発見できるため、以下のような問題が発生する前に問題を早期に訂正することもできます。

演習 1.4 では、コード・レビュー検出結果を修正し、演習 1.2 に基づく作業をさらに進めます。



演習 1.2 の要約

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

  1. 実行するコード・レビューを選択する
  2. コード・レビューに適用されているルールを表示する
  3. レビューを実行するコードの本文を選択する
  4. コード・レビューを実行する
  5. コード・レビューの検出結果を表示する
  6. 検出結果を選択し、その検出結果について以下の情報を確認する


これで、『演習 1.3: アーキテクチャー制御ルールの定義』の開始準備ができました。

フィードバック
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.
(C) Copyright IBM Japan 2005