上手いソースではなく読みやすいソースを書いてもらう

ソースは綺麗に書こう！というのはプログラマーなら誰でも思うことですが「どうしてこうなった？」というソースに出会うことがときどきあります。プロマネとしてはソースの可読性を起因としたバグは防ぎたいですよね。

そこで今回は「ソースを綺麗に書いてもらおう！」という話です。

■ この記事を書くきっかけになったソースの話

メソッドの引数が15個ある

15個も並んでたら読みにくいし、使いにくいでしょ・・・。

commonXxxxxの意味がわからない

例えば足し算をするクラス。

class CommonAddition{
・・・
}

「commonってつける必要ある？」っていうクラスが乱立している。
さらに・・・

class CommonAddition{
・・・
    a = a + 1;
    b = b - 1;
・・・
}

「これ混乱するでしょ？」って思うのですが、クラス名からは「足し算しかしない」と思わせておいて「引き算もしている」のように、クラス名やメソッド名から想像できないことを実施している。

上記のようなソースってバグの元ですよね。

■ 読みやすいか読みにくいかだけは考えてもらおう

「ソースを上手に書こう」と思うと難しくなると思うんですよね。でも「読みやすいか読みにくいか」ということだけを考えたら、まだマシなソースは書けるようになるんじゃないかなと思っています。

上記例のソースであれば「15個も引数があったら読みにくい」というのはぱっと見で読みにくいと感じるはずだし、commonが乱発されたら「commonって何？」ってなるし、クラス名やメソッド名から処理がわからないと、自分が逆の立場だったら混乱することは想像できると思います。

■ 文章もソースも読みやすさ

ソースも文章も同じだと思います。読みやすい文章は綺麗な文章ですよね。ソースも「読みやすい文章」を書くように書けば、きっと綺麗なソースになると思います。

プロマネとしては「上手いソースを書いて」とメンバーに言うよりも「読みやすいソースを書いて」という方が、メンバーは綺麗なソースを書いてくれるのではないかと思っています。