Ruby言語でプログラムを書く場合、文法的にあってさえいれば プログラムは動く。しかし、プログラムを作成していく過程では、 何度も読み直して修正して行ったり、他の人に見てもらう必要があるため、 一目見ただけでプログラムの構造が分かりやすいような形式で書いていく ことが望ましい。実際、構造が分かりやすいように気を付けて書いたものは 完成までにかかる時間が短くなる。
プログラムを書く場合のスペースの空け方、括弧の置き方など、色々な流儀 があるが、統一の取れたスタイルは読みやすい。以下のルールを守って書くと プログラムは非常に見やすくなる。
Emacsであれば全ての行で [Tab] キーを押すことで 自動的に揃えられる。
if y == 3 then x = 0 print "foo\n" end
↓
if y == 3 then x = 0 print "foo\n" end
揃えることで if, while, for などの制御構文がどこか
ら始まりどこで終わっているかが一目瞭然となる。C-SPC
でマークした位置からポイント位置までをまとめてインデントするには
M-C-\ (または M-x indent-region [Return])
をタイプする。
引数区切りなどのカンマの後には1つスペースを入れる。
printf("%sの残りのマッチは%d本です\n", who, match)
一般的に空白を多めにするとスッキリして見やすくなるが、入れすぎると どこが大事なのかがつかみにくくなる。とくに括弧の内側は 中に数式を入れることが多いので、数式を分かりやすくするためには 括弧の内側には空白を入れない方がよい。
× …… x[ i ] ○ …… x[i]
上記のルールのうち、インデント位置を揃える ことは プログラムのendの数が合わなくなるというミスを減らすためだけでなく、 プログラムの論理構造を視覚的に分かりやすくするために非常に重要である。