このセクションでは、レビューアーがコード レビューを使って作成者のコードをチェックする方法について説明します。
このセクションの内容:
一般的なワークフロー
レビューアーは次の作業を行います。
- [品質タスク] ビューでタスクをインポートまたはリフレッシュします。
- レビューする "リビジョン" または "コード レビューの問題" の [レビュー] ノードをダブルクリックして、レビューするソース ファイルの1 つを開きます。
- 選択したファイルのリビジョンが [比較] パネルに表示されます。作成者のリビジョンは [比較] パネルの左側に表示されます。そのファイルの前のリビジョンは右側に表示されます。コード レビュー は 2 つのリビジョンを自動的に比較し、最近の変更をハイライト表示します。右側のインジケーターは、選択したファイルに何個の変更点があるかを示します。インジケーターを使って、ある変更点から別の変更点へ簡単に移動することができます。
このアイコンは、レビューが必要なリビジョンを表します。
このアイコンは、コード レビューの問題がすでに入力済みであることを表します。
- 選択したファイルのリビジョンが [比較] パネルに表示されます。作成者のリビジョンは [比較] パネルの左側に表示されます。そのファイルの前のリビジョンは右側に表示されます。コード レビュー は 2 つのリビジョンを自動的に比較し、最近の変更をハイライト表示します。右側のインジケーターは、選択したファイルに何個の変更点があるかを示します。インジケーターを使って、ある変更点から別の変更点へ簡単に移動することができます。
- リビジョンを検証します。
- [コード レビューの問題] ビューが表示されていない場合、[Parasoft] メニューの [ビューの表示] > [コード レビューの問題] をクリックします。
- 追加する新規の問題ごとに次の操作を行います。
次のいずれかの方法で、関連するコードを指定します。
この項目にコメントを追加するには 方法 特定のコード行 1) [比較] パネルでそのコード行を右クリックします。
2) ショートカット メニューの [コード レビューの問題] をクリックします。
3) コメントを追加します。
コード レビューは自動的にコメントにファイル パスを追加します。1 つ以上の一般的な問題 1) 関連する [レビュー] タスク ノードを右クリックします。
2) [一般的な問題を追加] をクリックします。
3) コメントを追加します。
セッション タグ、タスク名またはコメント、および作成者とレビューアーが同じ場合、複数の [レビュー] タスク ノードを選択することができます。 同じプロジェクトのファイルに対して作成される一般的な問題も、このプロジェクト セットを持ちます。同じパッケージのファイルに対して作成される一般的な問題も、このパッケージ セットを持ちます。この問題は選択された際に設定されたのと同じセッションタグ、タスク名、およびレビューアー構成を持ちます。特定の問題に関連付いていない一連のファイル 1) 適切なコード レビュー ツリー項目を右クリックします。
2) [一般的なスレッドを追加] をクリックします。
3) コメントを追加します。- 問題を最もよく表すカテゴリを選択します。
- 問題の重要度を指定します。
- コメントを入力します。
- 対応する既存の "コード レビューの問題" ごとに、変更をレビューして [現行の問題への新しいコメントの追加] にコメントを入力します。
- 現在の問題に対応するためにさらに作成者のタスクが必要かどうかを示します。
- 修正 入力またはコメントした問題に対応するために、作成者がさらに修正を加える必要がある場合、[修正] ボタンをクリックします。修正の要求が作成者に割り当てられます。
問題がコミットされると、この修正リクエストが作成者に割り当てられます。 承認 以前に入力した問題が解決されたことを示すには、[承認] ボタンをクリックします。
これは、現在の問題に対してこれ以上アクションが必要ないことを表します。デフォルトのワークフロー ポリシーにチームが従っている場合、「承認」アクションがコミットされると、問題は「クローズされた」と見なされます。そうでない場合、問題は作成者に送られます。作成者はリビジョンをクローズできます。
- 修正 入力またはコメントした問題に対応するために、作成者がさらに修正を加える必要がある場合、[修正] ボタンをクリックします。修正の要求が作成者に割り当てられます。
- [コード レビューの問題] ビューの右上の [レビューをコミット] ボタンをクリックしてこの問題に対するコメントをサブミットします。
- このリビジョンをレビューするのが初めての場合、 次のステップで説明するように、この問題を「承認」または「完了」としてマークするまで、リビジョンはレビュー ツリーに表示され続けます。そのため、アレビューを続けたり、必要に応じてさらに問題を入力したりすることができます。これは次のアイコンでマークされたレビュー タスクに適用されます。
- 以前に入力した特定の "コード レビューの問題" に対応している場合、関連するコード レビュー タスクがレビュー ツリーから削除されるか、またはそのステータスが "待機" に変わります。これは、次のアイコンでマークされたレビュー タスクのコミットに適用されます。
- このリビジョンをレビューするのが初めての場合、 次のステップで説明するように、この問題を「承認」または「完了」としてマークするまで、リビジョンはレビュー ツリーに表示され続けます。そのため、アレビューを続けたり、必要に応じてさらに問題を入力したりすることができます。これは次のアイコンでマークされたレビュー タスクに適用されます。
- ファイルのレビューが完了した場合 (つまり、このファイルに対してこれ以上問題を追加する気はなく、コード レビュー ツリーから削除したい場合)、そのノードを右クリックし、[Mark as Accepted] または [Mark as Done] をクリックします (使用できるコマンドは構成によって異なります。詳細については下記を参照してください)。
ワークフローの図
次の図は、利用できる重要なワークフローを表しています。
詳細については 「ワークフローの概要」を参照してください。
レビューの却下 (コミット前のみ)
レビューを却下したい場合 (たとえばサブミットされた変更があるコードを元の状態に復帰したい場合)、コード レビュー ツリーの適切な項目を右クリックし、ショートカット メニューの [拒否] をクリックします。
担当レビューアーの追加と変更
たとえばセカンド オピニオンなどのために別のレビューアーを追加したい場合は、適切なコード レビューツリー項目を右クリックし、ショートカット メニューの [レビューの追加] をクリックします。
別のレビューアーにレビューを割り当てなおしたい場合は、適切なコード レビューツリー項目を右クリックし、ショートカット メニューの [タスクの再割り当て] をクリックします。