コード・レビューを実行するコード・ベースを選択するときには、
コードが所定の前提条件を満たしている必要があります。最も重要な点は、レビューを実行するときに
コード・ベースのすべてのファイルをコンパイルする必要があるということです。
コード・レビューを実行するときには以下の前提条件に注意してください。
これらの前提条件が満たされていないと、問題が発生する場合があります。
- コードはコンパイル可能でなければなりません。コンパイル不能なコードに対してコード・レビューを実行すると、
一部しかレビューされない場合や、結果が整合しない場合や、誤った結果が生成される場合があります。
- エンコードの問題があってはなりません。エンコードの問題があるために
プロジェクトを読み取れない場合は、コンパイル不能なセクションに対して実行できなくなり、
コード・レビューがまったく機能しなくなります。
- エンコード設定が正しくなければなりません。エンコード設定が誤っていると、
コンパイル不能なコードに対してコード・レビューを実行した場合と同様の結果となる場合があります。
以下の前提条件は、J2EE ベスト・プラクティス・コード・レビューのみに
適用されます。
- J2EE 動的 Web プロジェクトをコンパイルする必要があります。これにより、J2EE ベスト・プラクティス・コード・レビューの
すべてのルールをアクティブにできます。
- WebSphere® Studio
Application Developer (WSAD) ワークスペースからコードをマイグレーションする場合は、
サーバーを手動で設定する必要があります。プロジェクトを右マウス・ボタンでクリックし、
「プロパティー」 > 「サーバー」をクリックします。
警告
前提条件を満たしており、コード・レビューを実行する準備が整った後に
注意が必要な場合があります。
同じ Java パスに複数のファイルを置かない: ワークスペースで
コード・レビューを実行するときに、ファイルが異なるプロジェクトにある場合であっても、
同じ Java パスにある複数のファイルがカバーされないレビューがあります。この振る舞いには、
多くのシステム処理を必要とする以下のコード・レビューまたはルールが該当します。
- J2EE ベスト・プラクティス・コード・レビュー
- 完全コード・レビュー
このため、同じ Java パスに複数のファイルを
置かないようにしてください。
例: ワークスペースに RED_Examples プロジェクトおよび BLUE_Examples プロジェクトが
あるとします。いずれのプロジェクトにも bright.java ファイルを
含む Color パッケージがあります。ワークスペースでコード・レビューを実行するときに
レビューでカバーされるのは 1 つの bright.java ファイルのみです。2 つのファイルを
それぞれ brightr.java と brightb.java に名前変更するなどの方法で同じパスに置かないようにすると、
両方のファイルにあるコードをレビューできます。
ワークスペースの同じ Java パスに複数のファイルがない場合は、
以下の方法でワークスペースをセットアップすることにより、複数のファイルをカバーする
コード・レビューを実行できます。
- ワークスペースを分割し、1 つのワークスペースの
同じパスに 2 つのファイルを置かないようにします。
- 一度にロードするワークスペースを 1 つにします。
- ワークスペースごとに別個のコード・レビューを実行します。