GWも折返し地点に差し掛かりましたが、皆さんいかがお過ごしでしょうか。

やや話題の「ユニコーン企業のひみつ」を読んで
組織やビジョナリー・カンパニー的な仕事のモチベーションに想いを馳せつつ、
GWの前半は手元のコードを眺めていました。

プロジェクトで決められたことしかやらないうちに
負債が溜まったコードとはまさにこのこと。

今日は、いろいろと弄っているうちに感じた
「このコードが読みにくい理由」
を書き留めておきます。

読みやすさには個人差があるのと、
C# 以外のケースでは必ずしも当てはまらない内容かもしれません。

1. 名前付けに違和感を感じる

名前から "違和感" を多く感じるコードは非常に読みにくいです。
コーディングする上で名前を付ける場面は非常にたくさんあります。

コードを読んでいて違和感を感じた名前付けにはこんなものがありました。

些細なことと思うかもしれませんが、小さなジャブでもじわじわ効いてきます。
名前を変更することが可能かどうか確認し、IDEを使って安全に名前を変更しましょう。

2. 不要なコードが多い

不要なコードとしてはこんなものがありました。

IDEのヒントが出てくるので余計に気になってしまうのかもしれませんが、
不要な情報を削ぎ落とすことで読みやすくなりました。
「将来きっと役に立つ」の精神ではなく断捨離をすると楽になれます。

「その場しのぎの対応」とはこういうことを指すのでしょう。
サグラダ・ファミリア。
度重なる機能追加・不具合修正等の結果、
後の理解が非常に難しくなってしまうことってあると思います。

嫌な匂い的な何かを感じたら見直してみましょう。
時間がかかる場合もありますが、後に幸せになれるかもしれません。

「実はクラス内部からしかアクセスされていないのにpublicになっている」など、
アクセス修飾子が過剰に設定されていることにより、
クラス間相互作用の影響範囲が見えにくくなることがあります。
適切なアクセス修飾子に変更することで、
クラスの輪郭や役割がハッキリして理解しやすくなります。

1ファイルに複数のクラスをまとめると理解がしづらくなります。
privateでないネストされたクラスなどの濫用にも注意しましょう。
コードクリーンアップやリファクタリングの機能が非常に便利です。
ReSharper などを使ってコードをきれいに保ちましょう。

割れ窓理論という言葉もありますが、
不吉な匂いに対する感度を上げるためにも細かい整理が大切だなと改めて実感しました。