分かりやすい変数名をつけよう

1. 運⽤しやすくするために
わかりやすい変数名をつけよう
製品企画室 ⼟井 周平

2. ⾃⼰紹介
⼟井 周平
製品企画室(TOPSIC)
2

3. 『リーダブルコード』読んでみた
今回のテーマ: 変数の名前について
無意味な変数名はつけない
変数名に情報を詰め込む
真偽値の変数名にはis,has,can,shouldを使う
3

4. よく使っていた悪しき変数名
~学⽣時代の課題・卒論・競プロ~
4

5. こんな変数を使っていた
tmp, tmp1, tmp2, tmpa, tmpb
flag, f
count, amount
max, min
ary, a, str, s
width, w, heght, h
変数名を⾒ても、何の値なのかよくわからない...
5

6. 例) flagがお祭り状態
if(reflag == 1 ||
(flag2 == 1 &&
(2*Math.PI - 0.0001 <= total_theta &&
total_theta <= 2*Math.PI + 0.0001))){
if(search(n1,n2) == 0){
errorlist_id.push(n2);
errorlist_ver.push(l);
}
grouprepflag = 1;
}
正体不明のreflag, flag2, grouprepflagが混在
6

7. 無意味な名前をつけてはいけない
競技プログラミングと開発は違う!
⾃分が書いたコードを他⼈が読む
後からコードを読み返す機会が必ずある
読みにくいコードは運⽤しづらい!
7

8. 名前の付け⽅のコツは?
リーダブルコードを読んで、⾃分なりに考えたところ...
「ぱっと⾒て疑問に思った情報」 をつける!
8

9. 分かりやすい名前に直してみる
9

10. 例1) 変数countとは?
-> 何かの個数を表している?では何の個数?
"count"から"users_count"へ
-> ユーザーの⼈数を表している?どんなユーザー?
"users_count"から"admin_users_count"へ
-> 管理者ユーザーの⼈数を表している!
変数名に情報を詰め込む
10

11. 例2) 変数flagとは?
-> trueかfalseのどちらか?何かしらの条件に対しての真偽値?
"flag"から"cal_complete_flag"へ
-> 計算完了を表している?計算完了はtrueとfalseどっち?
"cal_complete_flag"から"cal_is_complete"へ
-> trueなら計算完了という意味!
真偽値を表す変数にはis, has, can, shouldなどを使う
11

12. 名前から変数の値や意味が
簡単に予想できるようにする
12

13. 運⽤しやすくするために
わかりやすい名前をつけよう
13