ハコ ノ ナカ

https://twitter.com/haco_no_nako

リーダブルコードを読んで思ったこと

結果から云うと読んで良かった。

読むことによって綺麗なコードを描こうと云う意識が高まった。

 

本書には、より良いコードを書くためのシンプルで実践的はテクニックが記載されており、「コードは他人が最短時間で理解できるように書かなければいけない」と云う考えが鍵となっている。

 

その中でも、特に心に留めておきたいことをまとめてみる。

 

 

 

  • 無駄な変数は使わない

無駄な変数は宣言しない。これは大事。変数が多いコードは読みにくい。

例えば以下のコード。

f:id:CapsLook:20150707013201j:plain

 このコードは汚い。無駄無駄無駄無駄無駄無駄ッ!!!

もっと良いコードが以下になる。

f:id:CapsLook:20150707014004p:plain

 変数は関数の間でしか生きれない。for関数の中で宣言された変数iは、for関数を抜けると消滅する。これによりmain関数内での宣言を回避できる。

 

  • 適切な変数名をつける

コードは他人が読んでも理解できるものであるべきなので、適当な変数名をつけるのは御法度です。

本書にこんな言葉が綴られていました。

「もしかすると、こんな風に考えているかもしれないね。『他の人が理解できるって、誰が得するんだよ?このコードを使っているのはオレだけなんだぞ!』。でもね、たとえ君ひとりのプロジェクトだったとしても、この目標に取り組むだけの価値があるんだ。『他の人』というのは、自分のコードに見覚えのない6ヶ月後の『君自身』かもしれない」。

これは心に刺さる。ってことなんで、変数名は適切で、尚且つ明確で、シンプルなものにしましょう。名前に情報を入れるのが大切。

下手なコメントを書くより、変数名で理解させるほうがスマートで格好良い。

コメントは飽くまで補填であるべき。

 

  • 一貫性のあるフォーマットを保つ

これは見た目の話。言葉で説明するより実際に見たほうが理解しやすい(以下)。

f:id:CapsLook:20150707021947p:plain

 FizzBuzzアルゴリズム

あー、汚い。キモい。親の顔がみたい。改行する箇所がバラバラだし、空白の幅が揃ってない。僕だったらこうする。

f:id:CapsLook:20150707022912p:plain

一貫性のある描き方をしているコードをみるのは気持ちがいい。似たような処理は纏めて描いたほうが見やすい。

 

 

ーーーーーーーーーーーーーーーーーーーー

他にもいっぱいあるけど、今日はこのへんで。