2018年05月23日（水） はじめてのIT勉強会で使用した資料です。

1. はじめてのIT勉強会 in 仙台
リーダブルコード
Part2: 誤解されない名前

2. 鈴木寛之（すーさん）はこんな人
 どんな技術でもやる雑草エンジニア
（フロント、バック、ETLもやってます）
 本を読むのが好き
 人を助けるのが好き
 Confluence（社内Wiki）の運用・推進活動
 社内LT（Lightning Talk）活動
 社内リフレクションカード活動
※実は教員免許も持ってます

3. それでは、始めますー

4. 誤解されない名前

5. 誤解されない名前？

6. 誤解されそうなコードを
見てみよう！

7. resultには何が入る？
var result = historyData.filter(“year <= 2011”);
B：2011年以前を除いた履歴データ
どっちの意味にもとれる
A：2011年以前の履歴データ

8. もう少し意味を
明確にしてみよう！

9. これなら分かりやすい
2011年以前の履歴データを「選択する」なら
var result = historyData.select(“year <= 2011”);
2011年以前の履歴データを「除外する」なら
var result = historyData.exclude(“year <= 2011”);
var result = historyData.filter(“year <= 2011”);
意味が明確になった

10. 「コレ、どっちの意味？」
だったら
それは、誤解されるコード

11. 「これは他の意味と
間違えられないか？」を
何度も自問自答しよう

12. 他の例も見てみよう！

13. 誤解される限界値

14. 誤解されるコード
const CART_TOO_BIG_LIMIT = 10;
if ( cart.item.count >= CART_TOO_BIG_LIMIT ){
new Error(“カートにある商品が多すぎます。”);
＜仕様＞
ショッピングカートには「10個」までしか商品が入らない

15. 先生！
このコードバグってます！

16. ん！？

17. 誤解されるコード
const CART_TOO_BIG_LIMIT = 10;
if ( cart.item.count >= CART_TOO_BIG_LIMIT ){
new Error(“カートにある商品が多すぎます。”);
＜仕様＞
ショッピングカートには「10個」までしか商品が入らない
実は、10個だとエラーになる

18. 誤解されるコード
const CART_TOO_BIG_LIMIT = 10;
if ( cart.item.count >= CART_TOO_BIG_LIMIT ){
new Error(“カートにある商品が多すぎます。”);
＜仕様＞
ショッピングカートには「10個」までしか商品が入らない
LIMITという言葉はあいまい。
10を含む？含まない？

19. 分かりやすいコード
const MAX_ITEMS_IN_CART = 10;
if ( cart.item.count > MAX_ITEMS_IN_CART ){
new Error(“カートにある商品が多すぎます。”);
＜仕様＞
ショッピングカートには「10個」までしか商品が入らない
MAXを使うと限界値が分かりやすい

20. 限界値を含める時は
minとmaxを使おう！

21. 次は

22. 誤解される範囲指定

23. 誤解されるコード
function print_int_range(start = 2, stop = 4) {…}
stopという言葉があいまい 
A：「2、3」が表示される
B：「2、3、4」が表示される

24. 分かりやすいコード
function print_int_range(first = 2, last = 4) {…}
lastだと理解しやすい 

25. 最後の要素を含む範囲は
firstとlastを使おう！
minとmaxでも良いよ
1 2 3 4 5
first last

26. 次は

27. 誤解されるブール値

28. 誤解されるコード
readPassword = true;
A：パスワードをこれから読み込む必要がある？
B：パスワードを既に読み取っている？
readが紛らわしい

29. 分かりやすいコード
これだと理解しやすい
読み込む必要がある：needPassword
もう読み込んだ ：isAuthenticated

30. もうひとつ

31. 否定のブール値も
避けよう！

32. 誤解されるコード
var disable_ssl = false;
SSLを無効にするという変数がfalseだから
無効の逆で、有効かな。

33. わかりづらい！！！

34. 分かりやすいコード
var use_ssl = true;
SSLを使うってことね 

35. ブール値は
trueとfalseの意味を
明確にしよう！
否定形も避けてね

36. 次は

37. 使う人の期待に合わせる

38. 誤解されるコード
public class StatisticsCollector {
public void addSample(double x){…}
public double getMean() {…}
getMeanだから、O(1)か。ハイハイ。

39. 先生！
Sampleを100万件
登録したら
getMeanの処理結果が
返ってきません！

40. ん！？

41. 誤解されるコード
public class StatisticsCollector {
public void addSample(double x){…}
public double getMean() {…}
＜注意＞
すべてのサンプルをイテレートして
total / numSample を返す

42. O(n) だった。。。

43. 分かりやすいコード
public class StatisticsCollector {
public void addSample(double x){…}
public double computeMean() {…}
computeだから計算するのか。
処理に時間かかる可能性があるな。気を付けよう

44. 使う人の期待を
裏切らない名前を付けよう！

45. 今日のまとめ

46. 誤解されない名前をつけるためには
名前をより明確に！
-> filter より select, excludeを使う
限界値を決める時は？
-> min, maxを使う
最後の要素を含む範囲の時は？
-> first, lastを使う
ブール値を使う時は？
-> isやneedなどを使う
-> 否定形を避ける
ユーザの期待に反することは避けよう！
-> get*()は軽い処理にしよう！

47. 最後にもう一度

48. 「これは他の意味と
間違えられないか？」を
何度も自問自答しよう

49. キーンコーンカーンコーン

50. これで
今日の授業を終わります！

51. ありがとうございました！

52. 誤解されない名前をつけるためには
名前をより明確に！
-> filter より select, excludeを使う
限界値を決める時は？
-> min, maxを使う
最後の要素を含む範囲の時は？
-> first, lastを使う
ブール値を使う時は？
-> isやneedなどを使う
-> 否定形を避ける
ユーザの期待に反することは避けよう！
-> get*()は軽い処理にしよう！