コード・レビューの概要

目的

コード・レビュー は、ソフトウェア開発者がコードをレビューする際に、プロセスを自動化する一連のルールです。 手動によるコード・レビューのプロセスでは、時間がかかる主観的な議論が行われる可能性がありますが、自動コード・レビューは、効果的で迅速であり、さらに一貫性があります。 自動コード・レビューを行うことで、手動によるコード・レビューを補うことができます。 自動コード・レビューは、手動によるコード・レビューに取って代わるものではありません。

利点

自動コード・レビュー・ツールは、以下のタスクを実行するため、ソフトウェア開発プロセスにいくつかの方法で付加価値をもたらします。

自動化されたプロセスは迅速であるため、コード・レビューを頻繁に実行できます。 コード・レビュー検出結果を使用することで、問題を早期に検出して訂正することが可能になるため、変更が非常に容易でコストがあまりかかりません。

提供されているコード・レビュー

いくつかのコード・レビューが提供されています。 コード・レビューごとに、フォルダーに編成された、異なる一連のルールが適用されます。 開発プロセスの段階およびレビューの目標ごとに、ニーズに合ったコード・レビューを選択できます。 以下の画面取りに示されているように、範囲が最も広いレビューは、完全コード・レビューです。このレビューでは、すべてのカテゴリーのルールが適用されます。

すべてのカテゴリーを表示するために展開された完全コード・レビュー

カテゴリーの中には、関連するコード・レビューが存在するものもあります。例えば、以下の画面取りに示されているように、J2SE ベスト・プラクティスのカテゴリーのみのルールを適用する場合には、J2BE ベスト・プラクティス・コード・レビューを選択できます。 これにより、コードの特定の局面に焦点を当てたコード・レビューを実行することができます。

縮小された J2SE コード・レビュー

ユーザー定義のコード・レビュー

ルールは、提供されているウィザードを使用して作成することができます。ウィザードを使用すると、一般と J2EE ベスト・プラクティスという 2 つのタイプのルールから選択できます。ソフトウェア開発者は、これらのルールを使用すると、コードの整合性を確保するルールを作成することにより、コード・レビューの機能を拡張できます。

ルールの重大度レベル

各ルールには、重大度レベルがあります。提供されているルールについて、ルールに割り当てられている重大度レベルを変更することができます。 ウィザードを使用してルールを作成する場合は、重大度レベルを指定します。 3 つの重大度レベルが、以下のアイコンで示されています。

「推奨」は最も低い重大度レベルですが、検出結果への対応が重要であることを軽視しないでください。 これらの検出結果は、エンジニアリング・チームが準拠すべき、一連のベスト・プラクティスと業界標準を反映しています。 これらの検出結果が差し迫った問題でない場合にも、今後これらが原因となって問題が発生する可能性があります。

以下の画面取りには、J2SE ベスト・プラクティス・コード・レビューの比較フォルダーにあるルールが示されています。フォルダー内のルールには、3 つの重大度レベルすべてが存在します。

テキスト

一部の問題に対する自動フィックス

一部の共通する検出結果にはクイック・フィックスが存在します。クイック・フィックスとは、提供されている自動解決機能です。 コード・レビューの検出結果にクイック・フィックスが存在する場合には、以下の図にあるいずれかのアイコンで示されます。

テキスト

要約

ソフトウェア開発のライフ・サイクルにおいて、コード・レビューは開発者仲間によるコードの本文のピア・レビュー・プロセスを自動化するものです。提供されているコード・レビューでは、以下のタイプのレビューを実行することができます。

また、アプリケーションの設計構造の整合性を保証することに特化した独自ルールを作成するために提供されているウィザードを使用することもできます。

自動コード・レビューは即時に実行できるため、コード・ベースの問題および不整合を早期に検出できます。そのため、これらの問題がアプリケーションの保守、スケーラビリティー、およびパフォーマンスに影響を与える前に、早期に問題を修正することができます。

これで、『演習 1.1: 必要なリソースのインポート』の開始準備ができました。

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