コードレビューの準備や指摘管理でお困りではないでしょうか

ご訪問をありがとうございます
本書で提案するツールを使うことで、コードの差分を抽出、可視化（エクセル出力）することができます
エクセルにコード差分がまとまっておりますので、修正に関する情報の追記やコードレビュー時の指摘をコード差分と一緒に残すことができます
Vector あるいは note よりダウンロードしてお試し頂けます

ここ に FreeBSD コード(一部) で差分比較し、出力さたエクセルを置いておりますので、どういうものが出力されるのか、ご興味をお持ち頂けた方はご確認くださいませ

コードレビューでの困りごとは？

コードレビューのやり方は現場それぞれでいろいろとあろうかと思います

基本的には、コードの差分を示しつつ、修正をした理由を仕様書や設計書を参照して、示すことで正当性を確認します
また、そのコードの形でよいのか、などのレビュアーによる指摘やアドバイスをレビュー議事録に記録します

コードレビュー中は、仕様書、設計書、コード、レビュー議事録の４種類のファイルを行き来することになります

このファイルを行き来する手間を本書で提案する ii-diff を使うことで軽減します

ii-diff とは

ii-diff は 修正前後のコードを入力として受け取り、その差分をエクセルに抽出、可視化するツールとなります

修正前後のコードを１ファイル１シートにまとめますので、事前に参照する仕様書や設計書の抜粋して書き込んでおくことができます

また、レビュー指摘を記録する列が用意されているので、レビュー中の指摘を残すことができ、レビュー議事録としてご活用いただけます

レビュー中に参照するファイルが１つになり、効率的にレビューを進めることができます

ご参考までに、活用方法を動画にしています

ii-diff が コードレビュー用の資料の作成をお手伝いします

特徴

• 超簡単操作、設定不要で２ステップ（ファイル選択⇒実行）の操作で実行できます

• 差分のあるセルを紫塗で強調表示します

• 比較対象の指定はファイル、フォルダに対応しています

• 差分を示す列（自動入力）、差分の意図やメモを記録する列（手動入力）を提供します

• あらかじめフィルタを設定しており、差分を示す列でフィルタすることで差分の確認の手間を軽減します

• 報告書として使えるように表紙を出力します

入手方法 および 実行方法

入手方法

下記の Vector あるいは こちら よりダウンロードすることができます

ダウンロードした zip ファイルを解凍し、お好みのフォルダに展開する

実行方法 ① GUI

1. ii-diff をダブルクリックで実行する

2. Browse ボタンを押下して、ファイルを選択する　（x２回）

3. Submit ボタンを押下する

実行方法 ② CUI

1. コマンドプロンプトを起動する

2. 以下のコマンドを実行する
   # ii-diff.exe <比較対象１のパス> <比較対象２のパス>

差分の確認方法

出力されるエクセルファイルには、下図のような表紙や差分シートがあります

例えば、差分結果シートのF列に「差分を示す列（自動入力）」がありますので、フィルタをすることで、差分のある行だけを簡単に確認できます

出力されたエクセルファイルを開いて、差分に対する意図や理由、メモなどを記載するなど、目的にあわせてご活用ください

コードレビューに限らず、設計書、テスト仕様書のレビューなど、レビューでは他の資料を参照し、指摘を残すことが求められています

コードレビューでは ii-diff がお役立ちできると思いますので、ぜひご活用いただいて、少しでもお役に立てたら幸いです

note から購入する

ご購入の前に

ご購入に際する注意点となります

• 試用期間は たっぷり３ヶ月間をご用意しております

• 試用期間中の機能制限はありません
  （但し、未購入の場合、ライセンスコードの登録画面が表示されます）

• 試用期間を終了すると主機能が使えなくなります

• ご購入後の返金は承っておりませんので、あらかじめご了承ください

試用期間中にご購入の検討を、よろしくお願い致します
みなさまの生活や仕事の中で、少しでもお役に立てるよう願っております

ご購入

本 note でライセンスコードを購入することができます

ご購入いただき、有料記事部分からライセンスコードをご確認ください
ご確認いただいたライセンスコードを、ii-diff 実行時に表示されるライセンスコードの登録画面にて登録することで、試用期間後もご利用頂けるようになります