命名に時間をかける

コードを書くと、定数、変数、クラス(Goだと構造体)やインターフェース、メソッド、関数、パッケージ、ファイルと、名を書くところが無限にある。

当然ながら、どういう名にするかは大事だ。可読性や利便性に影響する。

頭では理解していても、コードを書いて日が浅いと、可読性は認識されやすく、意識されやすいが、利便性はそこまで重視されにくい傾向がある気がしている。

例えば責務の大きい関数であれば、単語がたくさん並んで名前が長くなりやすい。空白ない中で単語がたくさん並んでいるので、読めば意味はわかる程度の可読性は担保されているものの、可読性が高いかというと微妙だ。関数の責務を減らして、関数名を短くできるならした方がさらに良い。

長さだけでなく、ワーディングも大事だ。メンテしているリポジトリの似た処理との一貫性は確認した方が良いし、言語のカルチャーもあるので、時間があれば公式ライブラリの書き方を読んでみるとかもした方が良い。

言語ごとのカルチャーは、それぞれドキュメントがあるから、それを読むと良い。会社にもよって違うこともあるので、公開されてるものがあれば比べてみると違いがあって面白い。言語ごとに"Style Guide"というワーディングで公開されていることが多い。

よくない命名しか思いつかないときは、なにかモヤっとした気持ちが残る。

いい命名が思いつくと、一気に心が晴れた気分になる。

ひとつひとつは小さいけど、大事なことだと思う。

ただ、納期があると、じっくり考える時間を取るのが難しくなったり、
忙しくてコードレビューにあまり時間取れなかったりもする。

事業の性質や状況に依存しやすいし、自分も素早く作ってデプロイしたくなる性分であるものの、プロダクトは価値の源泉なので、必要な時間として確保していきたい。