Kivaでエンジニアしている吉野です！
自分もエンジニアとして働き始めてから2年になりましたが、振り返ってみると「リーダブルコード」に書かれている基本の考え方は、スタートアップ・ベンチャー・大企業問わず共通して大事な考え方だなと実感しています。
そこで今回は、振り返り兼備忘もかねて実際に現場で使えるような感覚で、自分が大事だと思ったポイントをピックアップしてまとめていこうと思います！
リーダブルコードとは？
リーダブルコードは、プログラムのコードを、他の人が理解しやすいものにするためのコーディングルールを集約した書籍になります。
チーム開発であれば自分の書いたコードを他の人が読む場面はたくさんあるかと思いますが、本書ではそういった場面に活用できるコーディングのコツ（ルール）を学ぶ事ができる書籍となっています。
自分は、初めての業務でコーディングすることになった時に読んでみたので、技術書の入門としても比較的やさしい難易度かと思います！
大事だと思った内容をピックアップ
１：コードは理解しやすくする
以下でその方法に触れていきますが、この書籍を読む・活用する上での基本的なスタンスになってくるので、押さえておきたいポイントです！
誰かが自分の書いたコードを読んだ時、あるいは数ヶ月後の自分がコードを読んだ時、そのコードを理解するのを最短にするためにとても大事になっていきます。
２：名前に情報を詰め込む
例えば、値を返す関数なら「get」や「fetch」を使い、状態を更新する関数なら「set」や「update」を使うことで、呼び出す側が関数の挙動を予測しやすくなります。
単位や用途など、名前からその変数や関数がどう使われるかが分かると、コードを読んだ時に「ここで何が起こっているのか？」を瞬時に把握できます。
自分は他の人のコードや命名を参考にするところから意識していますが、codicのようなネーミングツールなども適切な英語の名前を命名することができるのでご参考までに！
３：コーディングスタイルは一貫性が大事
・プロジェクトのルールに合わせる
自分流にカスタマイズするより、既存のプロジェクトルールに従うのが無難です。チーム全体で同じスタイルなら、他の人がコードを読んで理解しやすくなるので一貫性を心がけるようにします。
・インデントや改行も大事
コードが整理されていると、論理の区切りや階層構造がはっきりするので、後から見直す際の手間を大幅に削減できます。VSCodeの拡張機能「Prettier」を使えば、自動でコードのフォーマットを整えてくれるのでとても便利です！
４：適切なコメントで意図を伝える
・「なぜこうしたのか」を記述
どうしてその書き方を選んだのか、背景や意図をコメントとして残すと、レビューや後の修正がスムーズに進むので、こういったメモ書きは残すように心がけます。
・具体的に書く
「これ」「それ」などの曖昧な表現は避け、何に対してのコメントなのか明確に。必要な情報だけを簡潔に書くことで、コメント自体も読みやすくなります。
５：複雑なロジックはシンプルに
・ループや条件分岐の整理
もし処理が複雑になってきたら、機能ごとに関数に切り分けて「ブラックボックス」化するのが有効です。そうすることで、各部分が何をしているのかが明確になり、テストもしやすくなります。
・関数は一つの役割に集中
一つの関数で複数のことをやろうとすると、理解しづらくなるため、できるだけシンプルに入力と出力がはっきりする設計を心がけます。
まとめ
自分もまだまだ完璧なコードは書けないのですが、基本となる「読みやすさ」「具体性」「一貫性」を意識しながら自分なりに改善していくことが大事だなと改めて実感しました。
個人的には、技術書の入門としてとりあえず一周読んでみるのもありかなと思ったのでお勧めしたいです！
最後まで読んでいただきありがとうございました！
株式会社Kivaのテックブログです。Kivaではモダンな技術を活用し「proteger」「uniweb」「AI多言語翻訳」「コブラウジング」など様々なサービスの開発を行っています。
Discussion