Download as PDF, PPTX
![クソース [kusource]
理解不能で変更困難なプログラムコード。
巨大かつ複雑で、重複しているケースも多
い。変更するたびにバグが発生し、バグが
収束することはない。
地方によっては、 uncodeと呼ばれる。
ネタです、申し訳ありません。uncodeの「un 」はローマ字読みしてください。](https://image.slidesharecdn.com/random-110912084044-phpapp02/85/slide-75-320.jpg)
ソースコードの品質向上のための効果的で効率的なコードレビュー
- 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.
- 21.
- 22.
- 23.
- 24.
- 25.
- 26.
- 27.
- 28. コードレビューの対象を絞る プログラム設計全体を俯瞰するレビュー デバック困難なデリケートな部分のレビュー 稚拙なコードに対する教育的なレビュー 対象を絞って、レビューしましょう これらのレビューは完全に切り分けて行ってください。
- 29.
- 30.
- 31.
- 32.
- 33.
- 34.
- 35. if if for if if if ネスト地獄です。よく考えずにコードを書くとこうなりますよね。
- 36.
- 37. Ctrl + C Ctrl + V Ctrl + V Ctrl + V 本人の承諾を得ております。
- 38.
- 39.
- 41.
- 42.
- 43. メトリクス計測は 様々な 種類があります
- 44. 本セッション では 何を計測するのか？
- 45.
- 46.
- 47. 巨大複雑重複コード 理解困難 変更困難 試験困難
- 48.
- 49. メトリクス計測ツール 活用により
- 50.
- 51. ご紹介するツール SourceMonitor コードの大きさ、複雑さを計測 CCFinderX コードの重複を計測 Cppcheck 静的解析によるエラーチェック 検索エンジンにて、各ツール名で検索すれば入手可能です
- 52.
- 53.
- 54.
- 55. 0001: // 余計な改行はカウントしない 0002: a = b 0003: + c; 0004: // ブレースはカウントしない 0005: m = a; 0006: if (b > m) { 0007: m = b; 0008: } ４ステートメント
- 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 ③ エッジ数 フローチャートの線の数 3 7 ノード数 ④ フローチャートの要素数 4 ⑤ 5 ８－７＋２＝ ３ ⑥ 8 6 ⑦
- 59.
- 60.
- 61. 循環的複雑度 Cyclomatic Complexity ↓５ 単純な構造 ↓１０ 良い構造 ↑３０ 構造に疑問 ↑５０ テスト、デバッグ困難 ↑７５ 変更時に誤修正を生む原因を作る
- 62.
- 63. 32を超えると バグを含んでいる 確率が高くなる by IBM IBMの調査結果があるそうです。
- 64. SourceMonitor デモ 簡単なデモを行いました。
- 65. CCFinderX コードクローン（重複したコード）の検出 コピー＆ペーストしたコードを顕在化 プログラム全体での重複チェックを行う 現在は、オープンソース化されている 更新終了しています。利用してるPythonのバージョンも古いです。注意が必要です。
- 66. CCFinderX デモ 簡単なデモを行いました。
- 67. Cppcheck 静的コード解析によるエラーチェック 未初期化変数の警告 バッファオーバーラン、メモリリークの検出 STLの正しい使用法の警告 現在、活発にアップデートをしています。商用のものが使用できない方におすすめです。
- 68. Cppcheck デモ 簡単なデモを行いました。
- 69. メトリクス計測を始めましょう 明らかに悪い部分を自動的に発見可能 客観的に数値化される リファクタリングを行う明確な基準ができる ソースコードの品質を一定以上に保てる 主観的評価では、人を納得させるのは難しいです。特にベテランは・・・
- 70. 計測できないものは コントロールできない Lord Kelvin メトリクス計測関係の本に引用されることが多い言葉です。
- 71.
- 73. チーム制作の授業の概要 前期、後期の半年毎のチーム制作 １チーム５～８名、２０チーム前後 学年を超えたチーム編成 アジャイル開発（XPとScrumをアレンジ） 本校の取り組みを紹介しました。
- 74.
- 75. クソース [kusource] 理解不能で変更困難なプログラムコード。 巨大かつ複雑で、重複しているケースも多 い。変更するたびにバグが発生し、バグが 収束することはない。 地方によっては、 uncodeと呼ばれる。 ネタです、申し訳ありません。uncodeの「un 」はローマ字読みしてください。
- 76.
- 77. ７つのコーディング規約 お尻は掻いても クソース書くな 実際の授業で利用したスライドです。
- 78.
- 79. １メソッド １０ ステートメントまで
- 80. １クラス １００ ステートメントまで
- 81.
- 82.
- 83.
- 84. ソースコードを 愛 せよ
- 85. tweet! ソースコードを 愛 せよ 恥ずかしがらずに、つぶやいてみましょう。
- 86.
- 87.
- 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.
- 108.
- 109. ソースコードを 愛 せよ ソースコードを愛していれば、クソースは書けません。