このセクションでは、コード レビュー UI でのコード レビュー タスクの表示について説明するほか、割り当てられたタスクに対して実行できるアクションについて概要を説明します。UI をカスタマイズする方法についても説明します。 

このセクションの内容:

概要 

コード レビューは、コード レビュー パースペクティブまたは製品固有のパースペクティブで使用することができます。 

コード レビュー パースペクティブを開くには、次のいずれかの操作を行います。

• ショートカット バーの [パースペクティブを開く] ボタンをクリックし、[その他] を選択します。[パースペクティブを開く] ダイアログで [コード レビュー] を選択します。
• [ウィンドウ] > [パースペクティブを開く] > [その他] をクリックし、[パースペクティブを開く] ダイアログで [コード レビュー] を選択します。
• コード レビュー パースペクティブを以前に開いたことがある場合、ショートカット バーの [コード レビュー] ボタンをクリックします。

SOAtest には、コード レビューを簡単にするために次のビューが用意されています。

• [品質タスク] ビュー: コード レビュー モードの場合、[品質タスク] ビューにはコード レビュー タスク ツリーが表示されます。[品質タスク] ビューには 2 種類のタスクが表示されます。レビューアーには、レビューが必要なコード リビジョンの [レビュー] タスクが表示されます。作成者には、レビューアーのコメントに対応する [修正] タスクが表示されます。 [品質タスク] ビューはデフォルトで表示されているはずです。コード レビュー モードにするには、ツールバーの [コード レビュー] ボタンをクリックします。
  
  
  
  
• コード レビューの問題: サブミットされたコードの変更について、コメントを追加したり参照することができます。この機能を使って、作成者とレビューアーはサブミットされたリビジョンの修正方法について話し合うことができます。[コード レビューの問題] ビューを表示するには、[Parasoft] メニューの [ビューの表示] > [コード レビューの問題] をクリックします。
• 比較エディター: 最新のバージョンのファイルと、ソース管理システムに格納されている前のバージョンのファイルとを比較して差異をハイライト表示します。 コミット後モードでは、比較エディターにはレビュー対象としてレポートされた 2 つ以上のリビジョン間の差異が表示されます。 また、デスクトップでのローカルな変更と、ソース管理システムにある前のバージョンとの差異も表示されます。比較エディターは、コード レビュー タスク ツリーで特定のリビジョンをダブルクリックすると表示されます。

コード レビュー タスクの UI へのインポート

「GUI への結果のインポート」の説明にあるように、インポートの設定によって、自分の品質タスクをインポートするときにコード レビュー タスクが自動的にインポートされることがあります。

割り当てられたタスクを [品質タスク] ビューにインポートするには、[Parasoft] メニューの [インポート] をクリックして目的のオプションを選択します。[カスタム タスク] を選択した場合は必ず [コード レビュー] チェックボックスをオンにしてください。

タスク ステータス インジケーター

コード レビュー タスク ツリーの構成によって、コード レビュー タスクには、ファイル名、リビジョン番号、最新リビジョンがソース管理システムにコミットされた時刻に加えて、ステータス インジケーターが表示されます。

使用されるステータス インジケーターは次のとおりです。

タスクに対するアクション

タスクに対してアクションを実行する主な方法は、コード レビュー タスク ツリー ノードをダブルクリックするか、右クリックして適切なショートカット メニュー コマンドを選択することです。アクションは、タスクのグループ (たとえばあるコード レビュー パッケージのすべてのタスクなど)、1 つのタスク (たとえばレビュー対象の 1 つの修正や、作業対象の 1 つのレビューアー コメントなど)、およびその間のあらゆるタスクに対して実行できます。

実行可能なアクション

実行できるショートカット メニュー コマンドは、右クリックしたタスク項目と自分の役割によって異なります。役割に関連するコマンドについては、作成者およびレビューアーについてのセクションで説明しています。一般的に、ショートカット メニューを使って次のアクションを実行できます。

• 別のチーム メンバーにタスクを再割り当てする
• タスクを削除する
• あるタスクから次のタスク (または前のタスク) に移動する
• タスク ツリーを展開または縮小する
• タスク ツリーのレイアウトを変更する
• タスクを「完了」としてマークする、タスクをキャンセルする、タスクを拒否する
• 比較エディターを開き、ファイルの最新バージョンと、ソース管理システムに格納された前のバージョンとの差異を表示する
• 新しいレビューアーを追加する
• レビューアーが追加したコメントを表示する

たとえば次のタスクを持つレビューアーは、ショートカット メニューの [前と比較] をクリックして 

コードの変更点を参照し、

[コード レビューの問題] に問題を追加することができます。

作成者はこのコメントを表示し、[コード レビューの問題] で対応することができます。

複数のタスクにアクションを適用する

項目のグループ (たとえば特定のファイルに対するすべてのレビュー) を表すタスク ノードを右クリックすると、そのグループ中のすべての適切な項目に、同じアクションを一度に実行することができます。たとえば、あるパッケージ中のすべてのアクティブなコード レビュー タスクを「完了」としてマークしたい場合、次の図にあるようにショートカット メニューの [完了としてマーク] をクリックします。

コード レビュー タスク ツリーのカスタマイズ

コード レビュー タスク ツリーは、さまざまな方法でカスタマイズすることができます。

レイアウト テンプレートを変更する

レイアウト テンプレートを選択、構成、カスタマイズして、どの要素を表示するかを指定できます。詳細については 「表示レイアウトと表示内容を変更する」を参照してください。

コード レビューのレイアウト例

コード レビューのレイアウトは、ファイル、日付、またはコメントによって変更することができます。

最適な表示が見つかるまで、レイアウトをいろいろと変更してみることを推奨します。以下に、コード レビューのレイアウトを開発者が設定する例を示します。

たとえば以下の画面のように設定できます。

このレイアウトは、開発者、タスク、コードの場所の順序で見ることができるようにアイテムをグループ化しています。  この開発者はこの順序で情報をブレークダウンするため、このレイアウトを選択しました。より具体的に言うと、次のようになります。

• 第 1 レベルのノードは、開発者/レビューアーによってブレークダウンされた情報を示します。これは、「自分が作成したコードのレビュー」と「実行しなければならないレビュー」とを区別するのに役立ちます。
• 第 2 レベルのノードは、レビューの日付を表示します。
• 第 3 レベルのノードは、コード作成者の作業について説明するコミットまたはコミット前のコメントを表示します。
• 第 4 および第 5 レベルのノードは、ファイルがコードのどこにあるかを連続的により粒度の細かい情報として表示します。
• 第 6 レベルのノードは、実際のファイルとそのファイルの現在のレビュー ステータスを表示します。

また、もっと簡潔なコード レビュー レイアウトを求めている開発者であれば、次の 4 レベルの情報だけを表示するかもしれません。

• コード レビュー タスクの実行 ノード
• レビューの日付
• コード作成者の作業について説明するコミットまたはコミット前のコメント
• 実際のファイルとそのファイルの現在のレビュー ステータス

あるいは、「1)最初に処理すべきコード レビュー はどれか」そして「 2) コードの変更の目的は何か」ということに特化したい開発者であれば、次のレイアウトを選択するかもしれません。

このレイアウトは「タスク タイプ」および「タスクまたはコメント」を表示しています。「タスク タイプ」は日付でチェックインをソートするため、レビューアーはどのコード レビューを最初に処理すべきかを把握することができます。また、「タスクまたはコメント」は作成者のコメントを表示するため、開発者はチェックインの目的を知ることができます。

外観

さまざまなツリー ノードで表示されるデータの内容をカスタマイズできます。[設定] ウィンドウの [コード レビュー] で使用するラベルを選択できます。

フィルター

[品質タスク] ビューでツールバーの [フィルター] ボタンをクリックして、 

フィルター条件を指定して表示内容にフィルターをかけることができます。