よい名前を付けましょうリーダブルなんたらとか

よい名前を付けまし
ょう
リーダブルなんたらとか
よしだあつし(@yalab)

よい名前を付けましょう - リーダブルなんたらとか Powered by Rabbit 2.0.5

自己紹介


自己紹介

省略


なぜ名前重要か？


なぜ名前重要か？

http://jp.rubyist.net/
magazine/?0001-Hotlinks


リーダブルコード


第2章名前に情報を詰め込む

✓ 2.1 明確な単語を選ぶ
✓ 2.2 tmp や retval などの汎用的
な名前を避ける
✓ 2.3 抽象的な名前よりも具体的
な名前を使う


第2章名前に情報を詰め込む

✓ 2.4 名前に情報を追加する
✓ 2.5 名前の長さを決める
✓ 2.6 名前のフォーマットで情報を
伝える
✓ 2.7 まとめ


第3章誤解されない名前
✓ 3.1 例: filter()
✓ 3.2 例: Clip(text, length)
✓ 3.3 限界値を含めるときは min
と max を使う
✓ 3.4 範囲を指定するときは first
と last を使う


第3章誤解されない名前
✓ 3.5 包含/排他的範囲には
begin と end を使う
✓ 3.6 ブール値の名前
✓ 3.7 ユーザーの期待に合わせる
✓ 3.8 例: 複数の名前を検討する
✓ 3.9 まとめ

注意

✓ ここから先は必ずしも正しいもの
ではありません。
✓ こうやったほうがいいんじゃね？と
いう僕からの提案だと考えてくだ
さい。


注意

✓ いろいろ聞きますので答えてくれ
るとうれしいです。
✓ rails の話だったりそうじゃなかっ
たり様々です。


getter と setter は無駄
class User{
function getAge(){
return $this->age;
}

function setAge($age){
return $this->age = $age;
}
}

getter と setter は無駄

class User
attr_accessor :age
end

user = new User(name: 'yalab')
user.age = 4


✓ getter だけとか setter だけなら
まだよいかも…
✓ jQuery の引数付き呼び出しは
setter で引数なし呼び出しは
getter はわりとかっこいい
✓ ruby にはそもそも
attr_accessor なんかがあるので
それを使おう

具体的過ぎる名前は変数には
向かない

//一週間立ったら削除する
$sevenDaysAgo = 7 * 3600 * 24;

if($lastAccess + $sevenDaysAgo < time()){
...
}


具体的過ぎる名前は変数には
向かない

limit_date = 7 * 3600 * 24
if last_access + limit_date < Time.now
end


✓ ハードコーディングは変更に弱い
✓ さきほどの例だと $limitDate と
か $expireDate?


過程はさておき最終的に得られ
るものの名前にする

class User
例えば誕生日から年齢を計算する場合
def calc_age
end

よりは
def age
end
end


✓ これは賛否両論
✓ リーダブルコード的にはおそらくア
ウト
✓ 万葉の大場さん的には推奨
✓ よしだも推奨


中間テーブルのネーミングをさ
ぼってはいけない

x users - users_groups - groups
o users - memberships - groups

x people - people_items - items
o people - orders - items


✓ 両方の名前でやると「中間テーブ
ルである」ということはわかるけど
それしかわからない
✓ 適切な名前がついてると例えばコ
メントでそれが何であったかなど
を残さなくてもよくなる


class 名は名詞、メソッド名は動
詞か名詞
class Order
def items
end

def sum
pluck(:price).inject(&:+)
end

def calc_tax
@tax = 10 * sum / 100
end

def total_all
sum + @tax
end
end


✓ プログラミングの対象はだいたい
値なのでだいたい名詞
✓ 動詞を使う時はオブジェクトの内
部の値を変える時
✓ 何かのトリガーになるものも動詞
✓ 動名詞は微妙


クラス名とメソッド名での名前の
重複を避ける
class Plan
def monthly_plan
end
end

ではなく

class Plan
def monthly
end
end


閑話休題


ここからはゲームをしましょう

✓ フレームインフレームアウト
✓ OSSなコードのリファクタリング
✓ 何かしらを設計してみる
✓ 名前をつけてやる


よい名前を付けましょうリーダブルなんたらとか

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (13)

Similar to よい名前を付けましょうリーダブルなんたらとか

Similar to よい名前を付けましょうリーダブルなんたらとか (11)