リーダブルコードでギクッと来たことを覚え書き

リーダブルコードはコードの表面上の改善と、コードの実装についての改善、２つの切り口からコードの可読性を上げる方法を述べている。文章は読みやすく親しみやすいが、内容は割と思い当たることが多くてギクッとすることが多い。以下は特にそう思った点。未来の自分への戒めとして書き残しておこう。

・変数名、関数名をテキトーに命名してはいけない。使用方法を具体的に表した名前にする。また変数のスコープはできるだけ短くすること。

・コードの見た目を統一すること。インデント揃えたり、引数が多い場合にはそれも揃えたりすることで、読み手の抵抗感を減らせる。

・機能ごとにブロックで分ける。関数内の機能のフェーズごとに段落分けを行って、必要ならコメントをつける。これも読み手の抵抗感を減らすのに役立つ。

・コメントを有効に使う。見たらわかるようなことをいちいち書かないこと。コードの改善点や関数の使用に際しての注意点を書いておくこと。

・ヘルパー関数を用意する。引数が多い場合や、関数内で下位問題をダラダラと解いている箇所がある場合は関数化してラップする。

・ライブラリの機能を把握しておくこと。すでにライブラリで用意されている関数やマクロを自分で用意したりしないようにする。空き時間を有効活用にしてマニュアルやドキュメントに目を通しておくこと。

・完璧（笑）な実装を目指さないようにすること。実際に想定される問題だけをうまく解決できればそれで良し。そういった心持ちをきちんと持っておくことでやたらとソフトを拡張して保守性を低下させることを防げる。