読みやすいコードとは?誰にとって読みやすいの?

こんにちは!ぐちです。

見やすいコードとは

個人でアプリやWebサービスを開発されている方もいらっしゃると思いますが仕事で開発をされている方はチームでの開発がほとんどだと思います。その際に読みやすいコードを書くように意識されていると思いますが「読みやすい」ってどういうことなんでしょうか。

個人の好み

コードってすごくコーダーの性格というか癖というか好みが表現されると思いますが誰にとって「読みやすい」コードを書くかというところが非常に重要になると思います。

例えば中括弧を行末にするか次の行にするかなどは完全に癖というか好みだと思いますがPHPでは違和感を感じてしまいます。

public function  getHoge() {

}

public function getHoge()
{

}

逆にC#などであれば中括弧は次の行に書くのが一般的だと思います。

public void getHoge()
{

}

public void getHoge() {

}

他にも演算子との間にスペースを設けるかどうかなども違和感を感じるというか気になる点ではありますよね。

String hoge="hoge";

String hoge = "hoge";

スペースを設けるかどうかでいうと条件分岐などの書き方もよく目につきますよね。

if(isset($val)){
    // TODO
}else{
    // TODO
}

if(isset($val)) {
    // TODO
} else {
    // TODO
}

ほんとちょっとしたことなんですが三項演算子を多用したり処理を多階層にネストしたり読みにくいとは言えないけど違和感のあるコードを書く人って本当に多いと思います。ソースコードのマージを取る際に余計な行まで対象になったりして作業効率が良くない事態になることもあるので共通ルールを設けたほうがいいですよね。

IDE

統合開発環境と呼ばれるツールを使えば主要な言語のフォーマッターが内蔵されているので書式ファイルさえきちんと設定しておけばチーム内でフォーマットがバラバラになることもないので便利です。

EclipseやNetBeansなどであれば簡単にチームで揃えることも可能ですしSublimeTextなども設定ファイルを共有すれば問題ないですね。

ほんとちょっとしたことなんですが毎日コミットするときに違和感を感じたり余計な行の差分まで表示されてしまうと生産性もガタ落ちですよね。こういったコーディング作業に入る前のルール決めって意外と重要になってきますね。

では今回はこのへんで。