失敗したコードレビュー


※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。

1.コードレビュー

コードレビューとは
ソフトウェア開発工程で見過ごされた誤りを検出・修正するためにソースコードの体系的な検査(査読)を行うこと.ソフトウェア品質を高めると同時に開発スキルの向上を図ることができる
by wikipedia

本日(2009/06/24),初めて会社でコードレビューを行った
結果を報告するとプログラムの説明でグダグダのボロボロだった
というわけで失敗に終わった.明日リベンジの機会があるので
本日(2009/06/24)感じたこと学んだことをまとめておこうと思う

ちなみに自分は非常に説明が苦手である
早く改善したいがすぐに改善できるものでもないので一歩一歩焦らず進んでいく

2.何でコードレビューをするのか

  • 全員がプログラムを共有する
  • レビューするコードの修正方法が妥当かどうか

インターネットを調べると他にも色々と書いてあるが
自分が考えてまたは知っていたことはこの時点では以上である

コードレビューをインターネットで調べるとレビュワーについては色々と出てくるが
肝心のプログラム作成者の振る舞いについては中々記事が見つからない
どうしてなのだろうか?

3.どうやって説明するかのポイント

どこを修正するのか明確に明示する
大きな観点で見るなら仕様変更そのもの
もう少し詳細にするときは何のプログラムのどのソースコードのどのメソッドを修正したのかなどになる

実際に説明するときは「ストーリー」立てて説明する
  • 何故修正するのか(前の問題点とそれに対する改善点)
  • 何故プログラムをこの修正方法で修正をしたのか
  • プログラムの修正点は全部網羅しているのか(漏れがないか,意外とこれが曲者)

ソースコードの印刷物について
修正したメソッドの全てを印刷する(前後の関係を見ないと分からないことがあるから)
印刷したソースコードには行番号をつける

それが正しいかどうか簡単に言うと根拠の提示について
実際にプログラムを動かして動作したでは不十分
 →もっと現在の事実に基づいた根拠が必要

動作ありきでプログラムを考えているならその考えは今すぐ捨てた方が良い
いつか必ず足元をすくわれる

これは自分用の指標
説明のとき質問受けて咄嗟に返答できないとき
 →5秒考えて何も浮かばないならわからないことを伝える

待たせたり沈黙は厳禁

4.明日もある

最初の方に書いたが今日は失敗してしまったため
また明日コードレビューがある
今日学んだことを念頭において修正したいと思う
簡単だが明日もあるのでここでおしまいにする

以上で終了
読んでいただいて非常に嬉しいです
ツールボックス

下から選んでください:

新しいページを作成する
ヘルプ / FAQ もご覧ください。