より美しいコードへ 〜自分へのルール〜

Rubyでソース書くときは絶対自分の中でコーディングルールを
確認することにしてる私。
こういうところは神経質にできてます。
 

  • コメント部の前後には改行入れる

 私的にはコメントは道路で言う所の標識だと思ってる。
 そのコードでコメントを書く程注意することを目立たせる為に
 前後で改行を行う。

def hoge
  puts "直進"

  #ここは落雷注意
  puts "ドッガーン"

  puts "直進"
end

 

  • defの前後には改行
def foo
end

def bar
end

 

  • class〜end後前には改行は入れない
class Hoge
  def foo
    puts "ほげです"
  end
end

 

  • 複数行はdo〜endで書く
array.eache do |i|
  puts i.to_s
end

 

  • 一行の場合は{}で書く
array.eache{|i| puts i.to_s }

 

  • メソッド呼び出しはできる限り()を付けない
hoge.method_1
hoge.method_2 aa, bb

 

  • レシーバが無いときのメソッド呼び出しで引数が無いときは()をつける

  これは変数とごっちゃになって醜い(見難い)から

method_1()
method_2 aa, bb

 

  • def部には引数がない時には、()をつけない
def method_1
end

def method_2(aa, bb)
end

 
Rubyはそれぞれ好きな書き方があるだろうけども、
自分の好きなものはこれだ!と思って固めてから書かないと
後で見返すと無性にリファクタリングしたくなってしまう(経験談)
 
書く前に一度紙に打ち出すといいかもしれません。