SlideShare a Scribd company logo
Submit Search
Upload
ソースコードの品質向上のための効果的で効率的なコードレビュー
Report
Moriharu Ohzu
日本工学院八王子専門学校
Follow
•
296 likes
•
55,337 views
1
of
109
ソースコードの品質向上のための効果的で効率的なコードレビュー
•
296 likes
•
55,337 views
Download Now
Download to read offline
Report
Technology
Moriharu Ohzu
日本工学院八王子専門学校
Follow
Recommended
オブジェクト指向できていますか?
Moriharu Ohzu
237.4K views
•
129 slides
良い?悪い?コードコメントの書き方
Shigenori Sagawa
42.6K views
•
50 slides
オブジェクト指向の設計と実装の学び方のコツ
増田 亨
95.1K views
•
76 slides
エンジニアの個人ブランディングと技術組織
Takafumi ONAKA
23.3K views
•
40 slides
やはりお前らのMVCは間違っている
Koichi Tanaka
145.6K views
•
66 slides
TLS, HTTP/2演習
shigeki_ohtsu
13.1K views
•
129 slides
More Related Content
What's hot
世界一わかりやすいClean Architecture
Atsushi Nakamura
47K views
•
77 slides
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
Koichiro Matsuoka
87.9K views
•
89 slides
DDDのモデリングとは何なのか、 そしてどうコードに落とすのか
Koichiro Matsuoka
48.4K views
•
65 slides
開発速度が速い #とは(LayerX社内資料)
mosa siru
61.3K views
•
18 slides
モジュールの凝集度・結合度・インタフェース
Hajime Yanagawa
16.7K views
•
100 slides
プログラムの処方箋~健康なコードと病んだコード
Shigenori Sagawa
8.9K views
•
59 slides
What's hot
(20)
世界一わかりやすいClean Architecture
Atsushi Nakamura
•
47K views
DDD x CQRS 更新系と参照系で異なるORMを併用して上手くいった話
Koichiro Matsuoka
•
87.9K views
DDDのモデリングとは何なのか、 そしてどうコードに落とすのか
Koichiro Matsuoka
•
48.4K views
開発速度が速い #とは(LayerX社内資料)
mosa siru
•
61.3K views
モジュールの凝集度・結合度・インタフェース
Hajime Yanagawa
•
16.7K views
プログラムの処方箋~健康なコードと病んだコード
Shigenori Sagawa
•
8.9K views
例外設計における大罪
Takuto Wada
•
68.5K views
Redisの特徴と活用方法について
Yuji Otani
•
101.4K views
クロージャデザインパターン
Moriharu Ohzu
•
19.6K views
心理的安全性を 0から80ぐらいに上げた話
Yusuke Hisatsu
•
102.1K views
ドメイン駆動設計のためのオブジェクト指向入門
増田 亨
•
48K views
リッチなドメインモデル 名前探し
増田 亨
•
14.4K views
REST API のコツ
pospome
•
52.3K views
Pythonはどうやってlen関数で長さを手にいれているの?
Takayuki Shimizukawa
•
38.1K views
CircleCIのinfrastructureを支えるTerraformのCI/CDパイプラインの改善
Ito Takayuki
•
528 views
オーバーエンジニアリングって何? #devsumi #devsumiA
Ore Product
•
5K views
リーンなコードを書こう:実践的なオブジェクト指向設計
増田 亨
•
15.6K views
ツール比較しながら語る O/RマッパーとDBマイグレーションの実際のところ
Y Watanabe
•
17K views
Java ORマッパー選定のポイント #jsug
Masatoshi Tada
•
90K views
オブジェクト指向プログラミングのためのモデリング入門
増田 亨
•
37K views
Similar to ソースコードの品質向上のための効果的で効率的なコードレビュー
ちゃんとした C# プログラムを書けるようになる実践的な方法~ Visual Studio を使った 高品質・低コスト・保守性の高い開発
慎一 古賀
86K views
•
84 slides
コードの複雑さを測ろう
Shinya_131
1.5K views
•
18 slides
第28回Tokyo.R
宏喜 佐野
2.6K views
•
65 slides
XP祭り関西2011 森崎 修司「プラクティスが有効にはたらく前提は明らかになっていますか?」
Shuji Morisaki
1.6K views
•
31 slides
テスト駆動開発入門
Shuji Watanabe
7.7K views
•
62 slides
Test Yourself - テストを書くと何がどう変わるか
Takuto Wada
38.3K views
•
49 slides
Similar to ソースコードの品質向上のための効果的で効率的なコードレビュー
(20)
ちゃんとした C# プログラムを書けるようになる実践的な方法~ Visual Studio を使った 高品質・低コスト・保守性の高い開発
慎一 古賀
•
86K views
コードの複雑さを測ろう
Shinya_131
•
1.5K views
第28回Tokyo.R
宏喜 佐野
•
2.6K views
XP祭り関西2011 森崎 修司「プラクティスが有効にはたらく前提は明らかになっていますか?」
Shuji Morisaki
•
1.6K views
テスト駆動開発入門
Shuji Watanabe
•
7.7K views
Test Yourself - テストを書くと何がどう変わるか
Takuto Wada
•
38.3K views
TDD を自分の道具にしよう
Yuji Okazawa
•
1.1K views
私のチームのリーダブルコード
Keisuke Tameyasu
•
851 views
後期講座07
Takenori Nakagawa
•
576 views
エンジニア・ミーツ・Coq プラスワン
wof moriguchi
•
2.2K views
Riderはいいぞ!
UnityTechnologiesJapan002
•
14.3K views
ADVENTUREの他のモジュール・関連プロジェクトの紹介
ADVENTURE Project
•
363 views
C#のココが好き!
Takaaki Suzuki
•
992 views
GCSアジャイル開発を使ったゲームの作り方
Hiroyuki Tanaka
•
3.3K views
非開発者のためのアジャイル開発入門
Kiro Harada
•
15.9K views
設計者がCAEを成功させる10の法則
Akira KURISAKI
•
4.6K views
第4回勉強会 単体テストのすすめ
hakoika-itwg
•
9.4K views
はこだてIKA 第4回勉強会 単体テスト
Seiji KOMATSU
•
783 views
Example of exiting legacy system
TakamchiTanaka
•
2.3K views
Code complete ch22_developper_test
Sho Shimauchi
•
849 views
Recently uploaded
pandas便利だけどデフォルトパラメータでファイルを読み込むな!
Hiro H.
87 views
•
13 slides
DLゼミ: MobileOne: An Improved One millisecond Mobile Backbone
harmonylab
32 views
•
30 slides
概念モデリングワークショップ 基礎編
Knowledge & Experience
16 views
•
71 slides
TaketoFujikawa_10thComicComputing2023
Matsushita Laboratory
81 views
•
24 slides
概念モデリングワークショップ 設計編
Knowledge & Experience
9 views
•
37 slides
01Booster Studio ご紹介資料
ssusere7a2172
154 views
•
19 slides
Recently uploaded
(11)
pandas便利だけどデフォルトパラメータでファイルを読み込むな!
Hiro H.
•
87 views
DLゼミ: MobileOne: An Improved One millisecond Mobile Backbone
harmonylab
•
32 views
概念モデリングワークショップ 基礎編
Knowledge & Experience
•
16 views
TaketoFujikawa_10thComicComputing2023
Matsushita Laboratory
•
81 views
概念モデリングワークショップ 設計編
Knowledge & Experience
•
9 views
01Booster Studio ご紹介資料
ssusere7a2172
•
154 views
IKEv2-VPN PyHackCon2023
Takayuki Shimizukawa
•
19 views
テストコードってすごい.pptx
cistb220msudou
•
70 views
マネージドPostgreSQLの実現に向けたPostgreSQL機能向上(PostgreSQL Conference Japan 2023 発表資料)
NTT DATA Technology & Innovation
•
183 views
さくらのひやおろし2023
法林浩之
•
11 views
pgvectorを使ってChatGPTとPostgreSQLを連携してみよう!(PostgreSQL Conference Japan 2023 発表資料)
NTT DATA Technology & Innovation
•
87 views
ソースコードの品質向上のための効果的で効率的なコードレビュー
1.
ソースコードの品質向上
のための 効果的で効率的な コードレビュー 日本工学院八王子専門学校 大圖 衛玄
3.
自己紹介
1992年~1997年 某ゲーム会社 プログラマ SFC,GB,PS1,N64のゲーム開発経験 1998年~現在 日本工学院八王子専門学校 @mozmoz1972 専任講師 プログラミング教育を中心に担当 twitterもfacebookも実名です。よかったらフォローしてください。
4.
アジェンダ コードレビューの必要性と問題点 メトリクス計測と関連ツールの紹介 本校の取り組み まとめ、質疑応答
6.
コードレビュー していますか?
7.
コードレビューが できない理由
8.
時間がない
9.
ソースコード量 パネェし
10.
気力も残ってないし
11.
うちの会社では 無理です(笑)
12.
(笑)ではありません
13.
よくある怖い話
14.
新人に仕事を丸投げ
15.
コードの酷さに 怒り爆発
17.
納期直前に絶望
19.
神に祈る
20.
神様どうかバグらないでください 神様どうか止まらないでください もう二度と悪いコードは書きません 毎日、早寝、早起きします 毎日、日記も書きます ゲームは1日1時間 南無妙法蓮華経 南無阿弥陀仏 アーーメン!
21.
新人の責任では ありません
22.
レビューを怠った 先輩の責任です
23.
コードレビューの問題点 手間、時間、気力の問題 大量のコードをどのようにレビューするのか? 全ソースコードのレビューは非現実的
24.
ペアプログラミング 全ソースのコードレビューが可能! たぶん、会社的に理解してもらえない 費用対効果も未知数 導入には勇気が必要です
25.
諦めない 知恵を使いましょう!
26.
コードレビューの効率化 時間がないのなら、レビュー対象を絞り込む 明らかに問題がある部分のみレビューする 優先度を決定する 時間を決め、短時間のレビューを行う
27.
最小限の時間で 最大の効果を上げる
28.
コードレビューの対象を絞る プログラム設計全体を俯瞰するレビュー デバック困難なデリケートな部分のレビュー
稚拙なコードに対する教育的なレビュー 対象を絞って、レビューしましょう これらのレビューは完全に切り分けて行ってください。
29.
本セッションは 教育的レビュー が対象です
30.
稚拙なコード とは?
31.
Large MIT石井教授のスライドを参考にしました。 CEDEC2010の基調講演は感動的でした。
32.
巨大な1枚岩のようなクラス、メソッド。初心者に多い非OOなコードです。
33.
Complexity
34.
一見して何をしているかわからない。迷路のようなコード。
35.
if
if for if if if ネスト地獄です。よく考えずにコードを書くとこうなりますよね。
36.
Duplicate
37.
Ctrl + C
Ctrl + V Ctrl + V Ctrl + V 本人の承諾を得ております。
38.
巨大複雑重複コードのレビュー 大量のコードから巨大複雑重複を発見する ソースファイルを1つずつ開いてチェック? 効率的に行う方法が必要
39.
メトリクス計測ツール を活用しましょう!
41.
メトリクス計測 していますか?
42.
メトリクス計測 やったことない
43.
メトリクス計測は
様々な 種類があります
44.
本セッション
では 何を計測するのか?
45.
ソフトウェアの 保守性を 計測します
46.
ソフトウェアの保守性とは? 可読性 理解が容易であるか? 変更性 変更が容易であるか? 試験性 デバッグが容易であるか?
47.
巨大複雑重複コード 理解困難
変更困難 試験困難
48.
Villainy
49.
メトリクス計測ツール
活用により
50.
極悪なコードを 自動的に 検出可能です
51.
ご紹介するツール SourceMonitor
コードの大きさ、複雑さを計測 CCFinderX コードの重複を計測 Cppcheck 静的解析によるエラーチェック 検索エンジンにて、各ツール名で検索すれば入手可能です
52.
Free
53.
SourceMonitor コード行数の計測 コメント行数の計測 ステートメント数の計測 循環的複雑度(サイクロマティック数)の計測
54.
ステートメント数 コメントや空白行を除く純粋なコード行数 {}(ブレース)も含まない セミコロン+制御文の数と考えてよい for文は3ステートメントでカウントされる
55.
0001:
// 余計な改行はカウントしない 0002: a = b 0003: + c; 0004: // ブレースはカウントしない 0005: m = a; 0006: if (b > m) { 0007: m = b; 0008: } 4ステートメント
56.
循環的複雑度
Cyclomatic Complexity 1976年にThomas J. McCabeが考案 制御構造に着目した複雑さのメトリクス コードの複雑さを数値化する 分岐が多いコードほど大きな数値となる
57.
m = a;
m=a if (b > m) { b>m m = b; } m=b if (c > m) { c>m m = c; } m=c フローチャートに直して説明します。
58.
① 循環的複雑度
1 ② エッジ数 - ノード数 + 2 2 ③ エッジ数 フローチャートの線の数 3 7 ノード数 ④ フローチャートの要素数 4 ⑤ 5 8-7+2= 3 ⑥ 8 6 ⑦
59.
ほぼ 制御文の数+1 になります
60.
複合条件 (&&、||) でも増加します
61.
循環的複雑度
Cyclomatic Complexity ↓5 単純な構造 ↓10 良い構造 ↑30 構造に疑問 ↑50 テスト、デバッグ困難 ↑75 変更時に誤修正を生む原因を作る
62.
循環的複雑度 10以下 が望ましい
63.
32を超えると
バグを含んでいる 確率が高くなる by IBM IBMの調査結果があるそうです。
64.
SourceMonitor
デモ 簡単なデモを行いました。
65.
CCFinderX コードクローン(重複したコード)の検出 コピー&ペーストしたコードを顕在化
プログラム全体での重複チェックを行う 現在は、オープンソース化されている 更新終了しています。利用してるPythonのバージョンも古いです。注意が必要です。
66.
CCFinderX
デモ 簡単なデモを行いました。
67.
Cppcheck 静的コード解析によるエラーチェック 未初期化変数の警告
バッファオーバーラン、メモリリークの検出 STLの正しい使用法の警告 現在、活発にアップデートをしています。商用のものが使用できない方におすすめです。
68.
Cppcheck
デモ 簡単なデモを行いました。
69.
メトリクス計測を始めましょう 明らかに悪い部分を自動的に発見可能 客観的に数値化される
リファクタリングを行う明確な基準ができる ソースコードの品質を一定以上に保てる 主観的評価では、人を納得させるのは難しいです。特にベテランは・・・
70.
計測できないものは
コントロールできない Lord Kelvin メトリクス計測関係の本に引用されることが多い言葉です。
71.
品質管理 計測必須
73.
チーム制作の授業の概要 前期、後期の半年毎のチーム制作 1チーム5~8名、20チーム前後
学年を超えたチーム編成 アジャイル開発(XPとScrumをアレンジ) 本校の取り組みを紹介しました。
74.
クソース問題 アジャイル開発は成功しましたが、ソースコードの質はひどい状態でした。
75.
クソース [kusource]
理解不能で変更困難なプログラムコード。 巨大かつ複雑で、重複しているケースも多 い。変更するたびにバグが発生し、バグが 収束することはない。 地方によっては、 uncodeと呼ばれる。 ネタです、申し訳ありません。uncodeの「un 」はローマ字読みしてください。
76.
クソース問題 SourceMonitorの計測を義務化していた しかし、完成優先でクソースを量産 動作させるので精一杯な学生も多いが… コーディング規約を決めることにした!
77.
7つのコーディング規約
お尻は掻いても クソース書くな 実際の授業で利用したスライドです。
78.
複雑度 10 まで
79.
1メソッド
10 ステートメントまで
80.
1クラス
100 ステートメントまで
81.
ネスト 2 段階まで
82.
複合条件 2つ まで
83.
フィールド 4つ まで
84.
ソースコードを
愛 せよ
85.
tweet!
ソースコードを 愛 せよ 恥ずかしがらずに、つぶやいてみましょう。
86.
クソース問題 コーディング規約のチェックをどうするか? SourceMonitorで全チームチェック? 20チーム以上を毎回計測するのは非効率 計測結果を一覧できる仕組みを作ろう!
87.
KuSourceMonitorの作成 SourceMonitorのXML出力機能を活用 XMLの計測結果を独自に集計しHTML化 違反数、違反率の集計表を作成 違反しているメソッドのソースコードを抽出
88.
バッチ処理用XML SourceMonitor
計測結果XML KuSourceMonitor コマンドラインによる バッチ処理で行います 集計結果HTML
89.
KuSourceMonitor
デモ 簡単なデモと、使用前、使用後のプロジェクト結果を比較しました。
90.
クソースの顕在化に成功 集計結果を共有サーバーにアップ 全学生が閲覧可能となる いじめにならないか? という懸念もあった 顕在化後、リファクタリングが活発になる
91.
顕在化による効果 クソースがさらされるのは誰でも嫌! 自尊心、羞恥心に訴える
できる学生ほど、プライドが高い チーム間の競争もあった 数値化されると燃える!という学生もいました。
92.
他人に見られていることを
意識すればコードは美しくなる Moriharu Ohzu ネタです。申し訳ありません。
93.
問題を顕在化
するのが 品質管理の基本です
94.
今後の取り組み 商用メトリクス計測ツールの導入
もっと多くのメトリクス計測が可能 クラス設計のメトリクス計測をしたい! 高精度の静的解析によるエラーチェックも! 本校では、Klocworkの導入に向けて、準備中です。
95.
クラス設計のメトリクス計測 継承の深さ、子クラスの数の計測 フィールド数、凝集性の計測
他クラスとの結合度の計測 明らかに設計が悪いクラスを検出できる 商用ツールは強力です。Javaの世界にはフリーでも良いツールが存在します。
96.
コーディング規約の調整
理想 標準 妥協 複雑度 5 10 20 ネスト 2 3 4 メソッド長 10 20 40 クラス長 80 160 240 今後の課題です。厳しすぎても、ユルすぎてもダメです。
98.
計測によるレビューの注意点 クソースは減りますが・・・ 静的解析にも限界はあります・・・
油断してはいけません 新人には丁寧なレビューをしてあげましょう! 短時間で良いので、レビューしてあげてください。
99.
理想的なコード 普通のコード クソース
100.
理想的なコード
普通のコード 計測によるレビューでは、クソースがなくなるだけです。
101.
計測によるレビューの注意点 明らかに悪い部分を検出するのが目的 理想を目指すなら、人力レビューが必要
人力レビューの効率化にも可読性が必須 クリーンなコードに対して、人力レビューする 理想を目指すなら、人力レビューが必要。しかしクソースはレビューする価値がない。
102.
計測によるレビュー
により 品質の底上げが可能 クソースがなくなるだけでも効果はあります。
103.
SourceMonitor
から はじめてみましょう! コードを計測する習慣をつけましょう。SourceMonitorは手軽なツールです。
104.
予算があれば
Klocwork 導入しましょう! 丸紅情報システムズ株式会社展示ブースにて 絶賛デモンストレーション中! CEDEC2011の展示ブースにて、デモが行われていました。
106.
まとめ まずは、計測するところから始める 計測により、効率のよいレビューが可能
計測結果を分かりやすく顕在化する 顕在化による効果は絶大! 顕在化しないと、意識が変わりません。
107.
保守性メトリクスに関しては、Code Qualityの第7章に詳しい説明があります。
108.
質問に関しては、ohzu@hac.neec.ac.jpにお願いします。
109.
ソースコードを
愛 せよ ソースコードを愛していれば、クソースは書けません。