コードレビューのススメ
•
100 likes•19,681 views
社内勉強会用に作成したコードレビューの資料です。 自社で実施したコードレビューの紹介と学んだ事から 今後実施する際に注意するべきポイントなどを共用する目的です。
Recommended
Recommended
More Related Content
Viewers also liked
More from kawahira kazuto
More from kawahira kazuto (6)
Recently uploaded
Recently uploaded (9)
コードレビューのススメ
- 5. C / C++ / AS等のソースコード バグが再現している状態へのリモート接続 設計中の宣言だけ書かれたヘッダー 持ち込まれる物 13年10月8日火曜日
- 10. コードレビューに 割いてる時間 1日1時間だが3人参加なので=3時間/日 毎日やっているので=60時間/月 4ヶ月継続したので=240時間 1人月換算 (160時間) で= 1.5人月 プロダクトは４ヶ月の期間で1.5人月の 作業時間がコードレビューに 割り当てられた 13年10月8日火曜日
- 11. ✓ 開発経験の低い人の改善に役立つ ✓ 無駄の発生が事前に気づきやすい ✓ 知らない事を学ぶ良い機会になる ✓ 設計の相談に役立つ 良いこと ✓ 時間制約があると効果が減りやすい ✓ 課題がドロップしずらい雰囲気 ✓ 知識差が大きいと聞くだけになる 悪いこと ✓ 得られる物が、減ってきた（無い） ✓ ポスト用のスクリプトが使いにくい ✓ メトリクス計測使えてない ✓ 理解度を上げる為の説明コストが高い 改善する事 先日 行われた 振り返り 13年10月8日火曜日
- 12. 良いこと ✓ 開発(経験の少ない人）の 改善に役立つ ✓ 無駄を事前に防止出来る ✓ 知らない事を学ぶ機会になる ✓ 設計、実装時の相談に役立つ 13年10月8日火曜日
- 13. 悪いこと ✓ 時間制約があると効果が薄い ✓ 課題を拒否しずらい雰囲気 ✓ 知識差が大きいと聞くだけに 13年10月8日火曜日
- 20. 導入 13年10月8日火曜日
- 27. ✓ 指摘するべき問題を絞り込む ✓ 見るべきソースを絞り込む ✓ 自動化する 効率化手法 ツールを活用する！ ツールを活用する！ 13年10月8日火曜日
- 36. 事例 13年10月8日火曜日
- 38. ✓ メンター役が平均的な良いコードと 悪いコードを既知のコードで指摘 ✓ どの様なコードがコードレビューで 指摘されるのか（するべきか）を学ぶ 準備 準備 練習 実施 13年10月8日火曜日
- 39. ✓ コードレビューの指摘を実践 ✓ ツールの使い方を学ぶ ✓ レビュー時の時間の使い方を学ぶ 練習 準備 練習 実施 13年10月8日火曜日
- 40. ✓ 会議室でコードレビューを全員で行う ✓ 自席で自分以外のコードをレビュー ✓ 一定周期でふりかえりを行う 実践 準備 練習 実施 13年10月8日火曜日
- 41. 注意点 準備と練習は １週間の人と２週間の人が居た Aさん Bさん 0 0.5 1.0 1.5 2.0 1週間 2週間 ※指摘などは得意、不得意がある 13年10月8日火曜日
- 43. 変更は作業中のうちからレビュアに見せておけ! 見せられる状態まで作るのでは無く、作業途中の 物をそのまま見てしまおう！ WIP ( Work In Progress ) DRY( Don't repeat yourself ) 情報の重複を無くせ！ コピペを憎もう！ キーワード 13年10月8日火曜日
- 49. 駄目なコード「その他」 ✓ 一般的なコーディング規約とは異なる書き方 ✓ 英語のスペルが間違っている ✓ 既存ソースがコメントアウトで残っている ✓ 入力値のサニタイズやレンジチェックが 各所に分散している http://www.ryuzee.com/contents/blog/610 ソースコードレビュー 13年10月8日火曜日
- 50. ソフトウェアの内部構造を改善する作業で あり基本的に以下の方針に従います。 ✓ 外部的な振る舞いは変えない ✓ 内部構造を洗練していく ✓ 作業は一歩ずつ進める ✓ 安全に変更を行う UMLモデリングの本質 第4章 4.1「リファクタリングの概要」 http://www.amazon.co.jp/exec/obidos/ASIN/4822221180/ Refactoring 13年10月8日火曜日
- 54. ✓ 指摘には簡単なルールがあると便利 (無いと何処を見て良いか迷う） ✓ 新しいとりくみには練習や準備が有効 ✓ 時間オーバーをしない工夫は大事 発見した事 13年10月8日火曜日
- 55. まとめ 13年10月8日火曜日
- 61. 小さく始める ✓ 小さい取り組みを継続的に行う ✓ 取り組みの成果を確認しつづける ✓ 小さな成功を繰り返す ✓ 組織やプロセスを着実に成長させる http://www.slideshare.net/devsumi/2013a1devops基礎からわかるDevOps 13年10月8日火曜日
- 62. 導入のススメ ✓ 同じチームで興味がある人が2人以上いれば その人達だけでも初めてみるのをお薦めします ✓ 社内ならツールもプロセスもサポートします ✓ 社外でもITSはあると思うのでプラグインを 一つだけ導入してもらえれば環境は十分 13年10月8日火曜日
- 63. 導入のススメ ✓ 計測は一緒にやっているメンバーが効果が あるか？で判定 ✓ プロセス自体の責任者（コードレビューを正常に正 しく実施する人）は必要 ✓ 最初から時間が短い中で効果を得るのは難しい 最初は長めの時間が必要 13年10月8日火曜日
- 64. 参考資料 http://steps.dodgson.org/b/2012/08/18/ code-review-styles/ コードレビューいろいろ http://www.slideshare.net/MoriharuOhzu/ss-9224836ソースコードの品質向上のための効果的で効率的なコードレビュー http://www.slideshare.net/Crest/ss-6031767より良いコードを書くための http://hiroki.jp/2012/09/13/5626/コードレビューツール 6選 どれが最適？ http://daipresents.com/2008/java_selfcheck_sheet/Javaの机上チェックリスト http://www.slideshare.net/tq_ed/writing-nice-code「いいコード」をみんなで書こう！ http://blog.ik.am/entry/view/id/138/Javaのソースコードレビュー観点をまとめてみた http://www.ryuzee.com/contents/blog/610ソースコードレビュー http://msdn.microsoft.com/ja-jp/library/ ms182019(v=vs.90).aspx デザイン レビューとコード レビューを実施するためのガイドライン http://japan.blogs.atlassian.com/2010/03/ア ジャイルチームにおけるコードレビュー-パー/ アジャイルチームにおけるコードレビュー ‒ パートII 13年10月8日火曜日
- 65. http://bitnami.com/stack/reviewboard BitNami Review Board installer How to install オール・イン Windows / Linux どちらも最新版が数クリックだけで Install可能！ ReviewBoard 13年10月8日火曜日
- 66. 文字化け対策 http://assam-at-night.blogspot.jp/2008/01/reviewboarddiff.html 夜でもアッサム ReviewBoardで日本語ファイルのdiffをとる BitNamireviewboard-1.7.6-0appsreviewboardLibsite-packageeReviewBoard-1.7.6-py2.7.eggreviewboarddiffviewerdiffutiliy.py 対象ファイル 変更内容 try: # First try strict unicode (for when everything is valid utf-8) return unicode(s, 'utf-8') except UnicodeError: # Now try any candidate encodings. for e in enc.split(','): try: - #u = unicode(s, e) + u = unicode(s, 'sjis') return u.encode('utf-8') except UnicodeError: pass 強制的に SJIS変換... diffutility.py 329行目 ReviewBoard 13年10月8日火曜日