「なぜ読みやすいコードが必要なのか」という記事を読んだ

「なぜ読みやすいコードが必要なのか」という記事を読んだところ、グサッとくる内容が多々あったので気づいたことや思ったことについて書いておこうと思います！

なぜ大切なのかという点について詳しく書いてありました！

元記事は以下です！

コードの可読性が大切なのは生産性を大きく左右するからとのことでした！

具体的に、可読性がたかいと以下のようなメリットがあります。

・読むのがスムーズ

・機能追加や変更がスムーズ

・バグが入りづらい

後々自分以外の誰かが読むこともあるであろうし、機能追加や変更をすることも出てくると思うので、先々のことを考えて綺麗で読みやすいコードを書いていかなくてはと思いました！

元記事にも書いてありましたが、コードは処理を実行できればOKという訳ではなく、人が読むという事も常に意識しておこうと思います。

コーディングで「オリジナリティを発揮してやろう！」としたことはありませんが、気づいたら一般的ではない書き方になっている事はしばしばあります。。。

一般的な書き方やマナーを知っておくのが大事だなと思いました。

１つのメソッドが長いと理解に時間がかかってしまいがちです。(自分の理解力が低いのもある気がしますが...)

一方、適切な単位で他のメソッドに切り出されていたりするものは読みやすいです！

気づくとif文が長くなってしまっていることが多々あります。

if 文で&&や||で繋ぎ過ぎているときは分割するなど対策を考えようと思います。

自分はまだ深すぎるネストには出会ったことがありませんが、読むのが大変そうなので書かないように気をつけます。

気を抜くと if hoge.id == 2 のように書いてしまいがちなので、マジックナンバーを書かない & ちゃんと定数にするということを習慣にしていかなくてはと思います。

後から見返したり、他の人が読んだら「2ってなんの数字だ？」って絶対なりますね。。。

自分がコードを読んでる時を思い返してみても、変数名やメソッド名が正しく分かりやすい名前になっていると、その変数やメソッドがどんな物なのか予想を立てた上で読み進めていくことができるので、理解がスムーズであることが多いです。

しかし意味がない名前や要点がズレた名前だと間違った先入観を持って読んでしまったりする為、どんな変数orメソッドなのか理解するのに結構時間がかかってしまいます。。。

変数やメソッドだけでなく、ブランチ名やプルリク名など他の人が読むもの全て名前はしっかり考えて決めていこうと思います。

今回の記事やリーダブルコードなどの「いいコードとは」系の内容は、時間が経って読み返してみると、最初はピンと来なかった内容がわかるようになっていたり、新しい気づきがありますね！

定期的に読み返していこうと思います！

haayaaa’s diary