リーダブルコードの要約

[yuyanegishi]

読みやすいコードである必要性

読みやすいコードにする目的は、チームでの開発を円滑にすることにある。読みやすい、また意味がわかりやすいコードであることで、他者（自分も含めて）がコードの理解や修正を行いやすくなる。

読みやすいコードとは

変数

• 変数名の意味が端的に表現されていること コード内で定義されている変数が何を表しているのかをしっかりと表現することと、端的に表現することで、短い単語数で的確に変数を表現する必要がある。 具体的な例として、以前取り組んだテスト１ー２の修正前のコードと修正後のコードの一部を比較してみる。修正前のコードではhash_tableという変数名では、データ構造はわかるものの、変数名だけでは中身に何が入っているか検討がつかないのに対して、courseid_teacherという表記からは、コースIDと教師のデータが入っていることが想像しやすい。 前置詞を使い要素の関係性を表現したり、単語同士の区切りをわかりやすくするためにアンダーバーを使う、また大文字で区切りを表現したりと、様々な工夫ができる。また、変数の単語を省略することも工夫の一つであるが（stringをstrと表現したり）、省略の方法としては一般的な共通認識がある場合のみ行う方が良いと考えられ、そのプロジェクト専用の省略の方法をしてしまうと、外部の人間や新規にジョインしたチームメンバーからは理解出来ないものになってしまう。

# 修正前のコード

# コースリスト： コース ID => [ コース名, 単位数 ]
courses = [ { 'M2001' => [ '数学２-１', 4 ] },
            { 'E1001' => [ '英語１', 2 ] },
            { 'H3001' => [ '歴史３-１', 3 ] } ]

# 教師リスト： 教師 ID => [ 教師名, [ 担当コース ID のリスト ] ]
teachers = [ { 1 => [ '佐藤', [ 'T4004', 'E1001' ] ] },
             { 2 => [ '鈴木', [ 'M2001', 'M2002' ] ] },
             { 3 => [ '田中', [ 'E1001', 'M2001' ] ] } ]

hash_table = Hash.new    # hash_tableというデータ構造はわかるが、変数名だけでは中身に何が入っているか検討がつかない

teachers.each do | hash1 |
    hash1.values[0][1].each do | item1 |
        if hash_table.key?(item1)
            hash_table[item1] << hash1.values[0][0]
        else
            hash_table[item1] = [hash1.values[0][0]]
        end
    end
end

courses.each do | hash2 |
    if hash_table.key?(hash2.keys[0]) 
        puts "#{hash2.values[0][0]} => #{hash_table[hash2.keys[0]]}"
    else
        puts "#{hash2.values[0][0]} => 担当教師無し"
    end
end

# 修正後のコード

# コースリスト： コース ID => [ コース名, 単位数 ]
courses = [ { 'M2001' => [ '数学２-１', 4 ] },
            { 'E1001' => [ '英語１', 2 ] },
            { 'H3001' => [ '歴史３-１', 3 ] } ]

# 教師リスト： 教師 ID => [ 教師名, [ 担当コース ID のリスト ] ]
teachers = [ { 1 => [ '佐藤', [ 'T4004', 'E1001' ] ] },
             { 2 => [ '鈴木', [ 'M2001', 'M2002' ] ] },
             { 3 => [ '田中', [ 'E1001', 'M2001' ] ] } ]

courseid_teacher = Hash.new    # courseid_teacherという表記から、コースIDと教師のデータが入っていることが想像しやすい

teachers.each do | teacher_list |
    teacher_list.values[0][1].each do | id |
        if courseid_teacher.key?(id)
            courseid_teacher[id] << teacher_list.values[0][0]
        else
            courseid_teacher[id] = [teacher_list.values[0][0]]
        end
    end
end

courses.each do | course_list |
    if courseid_teacher.key?(course_list.keys[0]) 
        puts "#{course_list.values[0][0]} => #{courseid_teacher[course_list.keys[0]]}"
    else
        puts "#{course_list.values[0][0]} => 担当教師無し"
    end
end

• 変数のスコープの範囲を縮める 変数のスコープの範囲はできるだけ制限をした方が良い。下記コード例では、変数strをそれぞれインスタンス変数とクラス変数で定義しているコードとなっている。そもそもstrがクラスの属性となり得るのかという議論もあるが、変数の適用範囲のみ考えると、strという変数を用いるメソッドが少ない場合などは、他のメソッドで変数strを参照することが無いので、適用範囲を狭めて、他のメソッドの影響が無いように定義する方が良い。

# 修正前のコード

class TestClass

  attr_accessor :name, :str

  def initialize(name)
    @name = name
    @str = ""
  end

  def make_hello
    @str = "Hello, World. I am #{@name}.\n"
  end

  def hello
    puts @str
  end

  # インスタンス変数を使用していないメソッドがたくさんある

end

# 修正後のコード

class TestClass

  attr_accessor :name

  def initialize(name)
    @name = name
  end

  def make_hello
    @@str = "Hello, World. I am #{@name}.\n"
  end

  def hello
    puts @@str
  end

  # その他メソッドは変数strが見えない

end

インデントの活用

• コードをブロック毎にまとめる インデントを活用して、コードをブロック毎にまとめることで、クラスやメソッドの定義、繰り返し構文の範囲等、それぞれの塊がどこからどこまでかを明確にする。下記、テスト２ー２の抜粋であるが、インデントを活用することで関数の定義範囲、if構文の適用範囲、繰り返し構文の適用範囲が明確になる。

# テスト２−２の一部抜粋

#素数判定関数の生成
def prime?(num)
  if num < 2
    return false
  else
    2.upto(Math.sqrt(num)) do | i |
        if  num % i == 0
            return false
        end
    end
    return true
  end
end

コメントの活用

• コードの意図や関数の動作を正確に記述する コメントアウトの機能を活用して、そのコードがどういった動作を行うものなのかを記述する必要がある。下記、Rails Turtorialのメソッドの定義を抜粋していますが、多くのメソッド等の定義を行うと、コードだけを見てもどのような動作が行われているのかがわからない場合も多くあるので、ある一定誰でも理解ができるように、コメントを活用して、コードの説明を行う。

# Rails Turtorial抜粋

# ユーザーがログインしていればtrue、その他ならfalseを返す
def logged_in?
  !current_user.nil?
end

# 永続的セッションを破棄する
def forget(user)
    user.forget
    cookies.delete(:user_id)
    cookies.delete(:remember_token)
end

# 現在のユーザーをログアウトする
def log_out
    forget(current_user)
    session.delete(:user_id)
    @current_user = nil
 end

制御フロー

• 条件式の引数の並び順 条件式の引数については、左側に調査対象を、右側に比較対象を置く。長さ（length）が10以上である条件式を書く際については、長さが調査対象で10が比較対象となるので、下記の（if length >= 10）のような条件式の書き方がわかりやすい。

# 左：調査対象　右：比較対象
if length >= 10

# 左：比較対象　右：調査対象
if 10 <= length

• if/else ブロックの並び順 基本的には条件は否定形よりも肯定形を使い、また、単純な条件や関心の引く条件を先に書くことでわかりやすい条件式を書くことができる（また、計算量踏まえて、先に書く条件を選択することもある）。

• 関数から早く返す 処理の対象外とする条件を先頭に集め、早めにreturnで抜けることでネストを減らし、エラー時の処理と通常時の処理をわかりやすくする。下記の例の条件文①では、false（エラー時）となる条件のnum1 == 0、num2 == 0の時にはfalseを返すように先頭行で指定している。

# 条件文①
def test_check(num1, num2)
  if num1 == 0 || num2 == 0
    result = false
  else
    result = true
  end
  return result
end

# 条件文②
def test_check(num1, num2)
  return false if num1 == 0 || num2 == 0
  return true
end

• ネストを浅くする ifを何回も入れ子にするとどういった条件の時にどういった処理がなされるのかがわかりにくくなってしまうので、極力ネストを浅くし、読みやすいコードにする。

テストと読みやすさ

• テスト

その他

• 巨大な式の分割