1. セッション
in
Javaで実践するリーダブルコードぷらす
2013.06.29
松本礼永

2. 自己紹介
• 名前：
– 松本 礼永
• 普段の仕事：
– 主にJavaで Webアプリケーション開発してます。
• 最近興味あること
– Ruby, Scala （え、今更 !? ）

3. リーダブルコード本
• 著
– Dustin Boswell
– Trevor Foucher
• 訳
– 角 征典

4. リーダブルコードって？
『読みやすいコード』（※）
どうなったらリーダブ
ルなの？
誰が判断する
の？
（※）書籍から抜粋

5. これってリーダブル？
If ( !isNotEmpty(str)){
}else{
do();
} それって、なくはないよね

6. どっちがリーダブル？

7. リーダブルの定義
『コードは他の人が最短時
間で理解できるように書か
なければならない。』（※）
（※）書籍から抜粋

8. 今日やりたいこと
他の人が最短の時間
で理解できるようなコード
の書き方を改めて見直す。
他の人のため？
コードの品質、何より
未来の自分のため

9. どうすればリーダブルになるか？

10. リーダブルにするための要素
• 名前
• コメント
• 制御フロー
• 処理の分割と構成

11. リーダブルにするための要素
•名前
• コメント
• 制御フロー
• 処理の分割と構成
情報をつめこむ。
誤解されない名前。

12. 名前に情報をつめこむ
明確で正確な単語

13. ページを外部から読み込み取得する
× ○

14. 名前で人のリストを検索する
×
○

15. 名前に情報をつめこむ
より具体的な名前

16. 文字列Listの中からヒットしたindexのリスト
を返す
×
○

17. DateからyyyyMMdd形式の文字列に変換
する。
×
○

18. 名前に情報をつめこむ
プレフィックス
と
サフィックス

19. ファイルサイズをチェックする。
×
○

20. 名前に情報をつめこむ
本当に省略してもい
いのか？

21. 意味不明な省略
×
○

22. 意味が伝わる省略
『新しいチームメイトはその名前の意味を理
解できるだろうか』
○
○
○
○

23. 誤解を生まない名前を付ける

24. 指定した文字列を含む要素を除外する
×
○

25. ファイル上限のサイズをチェックする
×
min, max / first, last (以上、以下) /
begin, end（以上、未満）
○

26. booleanの変数やメソッド名
×
○
is,has,can,shouldな
どを頭に

27. 名前を付ける時のポイント
『名前に情報をつめこむ』（※）
–複数の名前の候補から正確
で明確なものを選ぶ
（※）書籍から抜粋

28. 名前を付ける時のポイント
『最善の名前とは誤解されな
い名前である』（※）
–読み手が自分の意図を正しく理
解できる名前か
–他の人の意見も参考にする
（※）書籍から抜粋

29. リーダブルにするための要素
• 名前
•コメント
• 制御フロー
• 処理の分割と構成
・意図を伝える
・伝わりやすい形

30. 意図を伝える
価値のないコメント
をしない

31. コードをみればすぐに分かること
×

32. 不要な変更箇所コメント
×

33. むしろコードを直す
×
○
優れたコード
> > ひどいコード + 優れたコメント

34. 意図を伝える
自分の考え
を記録する

35. コメンタリー
○

36. 欠陥に対するコメント
○

37. 定数値の背景
○

38. 意図を伝える
読み手を意識
してコメントする

39. 質問されそうなことへの回答をあらかじ
め書いておく
○
はまりそうな罠、
全体像に関するコメントなど

40. 伝わりやすく
簡潔にコメントする

41. 代名詞を使わない
歯切れをよくする。
『情報の密度を高める。』
×
○
○

42. 伝わりやすく
正確に伝わる
コメントを書く

43. 動作を正確に記述する
×
○

44. 実例で補足する。

45. コメントを書く時のポイント
『コードの意図を読み手に
理解してもらう』 （※）
–無駄なコメントをしない
–自分の考えを記録
–読み手の立場で考える
（※）書籍から抜粋

46. コメントを書く時のポイント
『コメントは領域に対する情
報の比率が高くなければな
らない』 （※）
–簡潔に、正確に
（※）書籍から抜粋

47. リーダブルにするための要素
• 名前
• コメント
• 制御フロー
• 処理の分割と構成
・自然な流れで立ち止り、読み
返しをなくす

48. 自然な流れ
条件式の引数
の並べ方

49. 変化する方を左に置く。
調査対象(変化) 比較対象（固定）
×
○
×
○

50. 自然な流れ
if/elseブロック
の並び

51. ifの条件を素直に
×
○
If-elseの条件は、
否定より肯定

52. 自然な流れ
ガード節で
ネストを浅く

53. メソッドでは早めにリターン
×

54. メソッドでは早めにリターン
○
ループでは
break,continueで早
めに返す。

55. 制御フローを書く時のポイント
『制御フローはできるだけ自
然にする。コードの読み手
が立ち止まったり読み返し
たりしないように書く』 （※）
（※）書籍から抜粋

56. リーダブルにするための要素
• 名前
• コメント
• 制御フロー
•処理の分割と構成
一度に１つのことをやるように分割
コードのレベルをそろえるように構成

57. 一度に１つのことをやる
タスクを列挙
して
処理を分割する
『一度に１つのタスク』

58. コードのレベルをそろえる
無関係の下位問題
を
抽出する
『高レベルの目標に直接効果が
あるのか？』

59. 処理の分割と構成をするポイント
『コードは１つずつタスクを行
なうようにしなければならな
い。』 （※）
– タスクの列挙
– 処理の分割
（※）書籍から抜粋

60. 処理の分割と構成をするポイント
『無関係の下位問題を積極
的にみつけて抽出する』 （※）
– コードのレベルをそろえる
（※）書籍から抜粋

61. リーダブルにするための要素
名前
コメント
制御フロー
処理の分割と構成

62. まとめ
• リーダブル = 読みやすさ
• 読みやすさ = 理解しやすさ
• リーダブルなコードをかくと…

63. 『やったもん勝ちなんや！！
やらんもんは…勝たれへん！』 （※）
（※）書籍から抜粋

64. ご清聴ありがとうございました。