入社1年のプログラマが思う分かりやすいコードの大切さ

初めまして。プログラマーの須田です。

私はゲーム系の専門学校を卒業し、2022年にシンソフィアに入社しました。
現在はクライアントエンジニアとして働いています。

今回はゲーム業界を目指す学生の方向けに、私が働く中で気づいた読みやすいコードの大切さを伝えられたらと思います！

読みやすいコードはなぜ大切なのか

読みやすいコードを書くことが大切だと思ったきっかけは二つほどあります。

これらについて、実際に体験したことを踏まえて解説したいと思います。

プロジェクトに配属されてから、GitHubを使いプルリクエストなどでコードを見てもらうことが増えました。

プルリクエスト（Pull Request）とはプログラムや画像などの変更内容を他の作業メンバーにレビューをしてもらい、事前にバグや他の作業に影響がないか確認することが出来る機能です。

レビューをしてもらう時、読みにくいコードだと可読性から指摘されてしまいます。
プログラムのロジックやパフォーマンスなど重要な箇所に到達するまでの時間が増えます。

また、開発現場では自分の書いたコードを他のメンバーに使用してもらうことがあります。
その際に読みにくいコードのままだと、理解するのに時間がかかり作業効率も悪くなります。

このように、学生時代と違い、自分の書いたコードを他者に見てもらう事が圧倒的に増えました。
そのため、他のプログラマが理解しやすいように読みやすいコードを書くことが大切だと感じています。

開発現場で働くと、機能の追加や変更が頻繁に行われ、自分の書いたコードを変更する必要があります。
読みにくいコードの修正は、変更箇所を読み解くことから始まるため、余計な時間がかかります。

例えば次のようなコードがあります。

for (var i = 0; i < hogeArray.Length; i++)
{
    if (hogeArray[i].isEnabled)
    {
        // 複雑な処理
    }
}

この場合、if文内の処理を考える時にフラグを意識する必要があります。

これを下記のように変更してみます。

for (var i = 0; i < hogeArray.Length; i++)
{
    if (!hogeArray[i].isEnabled)
    {
        continue;
    }
    // 複雑な処理
}

このようにすれば、先にif文が完了しているので、それ以降の処理でif文を意識する必要がなくなります。

働く中で、何度か先輩が書いたプログラムを引き継ぐことがありました。
クラスやメソッドの機能がまとまっているため、機能追加がしやすかったことを覚えています。

紹介してきたように、読みやすいコードを書くことは重要です。
では、読みやすいコードを書くためにはどのようなことをすべきなのでしょうか？

効果的な手法は、誰かにコードレビューをしてもらうことだと思います。

会社では先輩にコードを見てもらうことが出来ますが、学生の間はなかなか機会がないと思います。
なので、身近な先生や同級生に見てもらうと良いかもしれません。
自分では見つけられなかった方法や異なる視点で意見を貰えると思います。

他には、コーディングに関する技術書を読むことも効果的です。
私はリーダブルコードという本を先輩に勧められて読みました。
本を読んだ後、意識ができるようになり指摘を受ける回数が少なくなりました。

振り返ると、指摘されたことは学生時代にも学べたものばかりです。
レビューを貰ったり本を読んだり、もっと勉強していたらと良かったなと思っています。

今でも足りていない部分があり、勉強の日々が続いています。
ですが、先輩方に丁寧なアドバイスを頂けて楽しく働くことが出来ています。

この記事で何か一つでも伝わるものがあれば嬉しいです。
それでは最後まで読んでいただき、ありがとうございました。