良いコードについて改めて考えたきっかけ
良いコードについて、改めて私の中で整理したくなり、以下の3冊を読みました。
- 『プリンシプル オブ プログラミング』
- 『リーダブルコード』
- 『良いコード/悪いコードで学ぶ設計入門』
『リーダブルコード』は以前にも読んでいましたが、改めて読み返すと、命名やコメント、条件分岐、処理の分割など、普段の実務で意識していることを再確認する内容が多くありました。
あわせて、プログラマにとって普遍的な価値観を学べる『プリンシプル オブ プログラミング』と、ITエンジニア本大賞2023 技術書部門大賞を受賞した『良いコード/悪いコードで学ぶ設計入門』の改訂新版も読みました。
今回この3冊を読み比べて考えたかったのは、単に「どの本がわかりやすいか」ではありません。
- 自分が普段コードを書くときに何を意識しているのか
- 読みやすいコードと、変更しやすいコードは何が違うのか
- チームで開発するときに、良いコードの基準をどう共有すればよいのか
この記事では、3冊を読んで感じたことに加えて、実務でコードを書く中で私が気をつけていること、そしてこれから読む人にはどんな順番で進めるのがよさそうかをまとめてみました。
そもそも良いコードってなに?
良いコードとは、あとから読んだ人が理解しやすく、変更しやすく、壊れにくいコードだと考えています。
数か月後の自分が読み返すことも他の人が修正こともあります。
仕様変更によって、想定していなかった修正が入ることもあります。
そのときに、書いた本人にしかわからないコードや、少し変更しただけで別の箇所が壊れるコードは、長期的には大きな負債になります。
最初から完璧なコードを書くのは納期もありますし、仕様が固まっていないこともあり難しいです。
実務では、理想だけでコードを書けるわけではありません。
それでも、読みやすさや変更しやすさを意識しているかどうかで、数か月後の保守のしやすさはかなり変わると感じています。
今回読んだ3冊に共通していたのは、「良いコードを書くこと」はセンスだけで決まるものではなく、原則・習慣・設計の考え方を身につけることで、少しずつ改善していけるという点だと感じました。
私が普段コードを書くときに気をつけていること
ちなみに、私が普段コードを書くときは、次のようなことを意識しています。
| 意識していること | 理由 |
|---|---|
| 変数名・関数名は役割が伝わる名前にする | 中身を読まなくても処理の意図を追いやすくするため |
| ハードコードを避ける | 変更時の修正漏れを防ぐため |
| コメントは意図を補足するために書く | 「なぜそうしたのか」をあとから理解しやすくするため |
| 値や型を前提で扱わない | 想定外のページや条件でエラーを出さないため |
| 処理を大きくしすぎない | 読み返しや修正をしやすくするため |
| 条件分岐を複雑にしすぎない | 処理の流れを追いやすくするため |
| 影響範囲を意識して書く | 修正による巻き込みを防ぐため |
たとえば、変数名や関数名は、できるだけ役割が伝わる名前にするようにしています。
data や list のような名前は便利ですが、増えすぎると中身を毎回確認しないと意味がわからなくなります。
記事一覧のデータであれば、単に data とするよりも、blog_posts や news_posts のように、何のデータなのかが伝わる名前にした方が読みやすくなります。
また、URL、ID、数値、文言、ステータス値などを直接いろいろな場所に書かないことも意識しています。
同じ値が複数箇所に散らばると、あとから変更が入ったときに修正漏れが起きやすくなるからです。
コメントについても、処理をそのまま説明するのではなく、意図を補足するために使うようにしています。
「何をしているか」よりも、「なぜそうしているのか」が残っている方が、あとから読む人の助けになると感じます。
処理を大きくしすぎないことも大切だと思っています。
最初はその場で書いた方が速いこともありますが、処理が大きくなると、あとから読むのも修正するのも難しくなります。
抽象度の高い処理や、複数の役割を持ち始めた処理は、関数化したり、ファイルを分けたりして見通しをよくするようにしています。
条件分岐も、複雑になるとコードを読む負担が一気に増えます。
ネストが深くなりすぎていないか、同じような条件判定が複数箇所に散らばっていないかは、なるべく気にするようにしています。
また、コードを書くときは、その変更がどこに影響するのかも意識するようにしています。
関数名、クラス名、CSSのセレクタ、定数名などを変更するときは、grepしながら他の箇所で使われていないかを確認することが多いです。
一箇所だけ直したつもりでも、別のページや別のパーツで同じ処理・同じスタイルが使われていることがあります。
そのため、この関数を変えたら他のページに影響しないか、このCSSは別のパーツにも当たらないか、この値を変更したときに他の画面が壊れないか、という点はなるべく確認するようにしています。
こうした影響範囲を確認しながら対応することは、変更に強いコードを書くうえで大事だと感じています。
リファクタリングについて思うこと
実務では、最初からきれいなコードを書けないこともあります。
納期が近かったり、仕様がまだ固まりきっていなかったり、とりあえず動くものを先に作る必要があったりします。
たしかに最初は勢いで書いた方が速いです。
場合によっては、やむを得ずハードコーディングを残すこともあります。
ただし、その場合でも「なぜ一時的にそうしているのか」「あとで何を直す必要があるのか」が分かるようにしておくことが大切だと思います。
たとえば私の場合、あとで見直す前提の箇所には 「TODO:」 コメントを残し、後から grep できるようにしていたりもします。
ただ、そのままの状態で放置してしまうと、あとからかなり苦しくなります。
完璧に直せない場面でも、問題の所在を見える形で残しておけば、将来の修正対象として回収しやすくなります。
最初は速く作れたとしても、あとから修正しにくいコードになってしまうと、結果的に手戻りが増えます。
だからこそ、リファクタリングが必要になります。
ただ、リファクタリングは「なんとなくコードをきれいにする作業」ではありません。
仕様を変えずに、読みやすく、変更しやすい状態にするための作業です。
そのためには、そもそも「良いコード」の基準を持っていないと、何をどう直せばいいのか判断はできません。
- 関数に切り出すべきなのか
- ファイルを分けるべきなのか
- 名前を変えるべきなのか
- どのように責務を分けるべきなのか
こうした判断は、単なる好みではなく、読みやすさや変更しやすさを基準に考える必要があります。
私がコードを書くときやリファクタリングするときは、変数名や関数名から役割が伝わるか、同じような処理が散らばっていないか、条件分岐が複雑になりすぎていないか、値が存在する前提で書かれていないか、といった点を意識しています。
コードレビューでも、基本的には同じ目線で見ています。
単に「動くかどうか」だけではなく、あとから読みやすいか、変更しやすいか、影響範囲を追いやすいかを確認します。
良いコードの基準がチーム内で共有できていると、レビューもリファクタリングも進めやすくなります。
今回読んだ3冊は、コードを書く人だけでなく、レビューする人やプロジェクトに関わる人たちとの間で、良いコードに対する共通認識をつくるうえでも役立つ本だと感じました。
おすすめの読む順番
実務経験が浅い人や、これから良いコードについて学びたい人には、まず『プリンシプル オブ プログラミング』で、プログラミングに向き合ううえでの考え方や原則を知るのが良いと思いました。
この本はコード例を読んで学ぶタイプの本ではなく、完全な初学者が読むと少し抽象的に感じるかもしれません。
ただ、最初に考え方の土台を持っておくことで、その後に読む本の内容も理解しやすくなると感じました。
そのうえで、次に『リーダブルコード』を読むと、命名、コメント、制御フロー、処理の分割など、日々の実装ですぐに意識できる内容を具体的に学べると思います。
最後に『良いコード/悪いコードで学ぶ設計入門』を読むと、読みやすさだけでなく、変更に強い設計や責務の分け方について理解を深めやすいと思いました。
私が読むなら、次の順番が良いと感じました。
- 『プリンシプル オブ プログラミング』
- 『リーダブルコード』
- 『良いコード/悪いコードで学ぶ設計入門』
まず、プログラミングに向き合うための考え方を知る。
次に、読みやすいコードを書くための具体的な技術を学ぶ。
最後に、変更に強い設計について学ぶ。
この流れで読むと、3冊の役割がつながりやすいと思いました。
1冊目:プリンシプル オブ プログラミング
『プリンシプル オブ プログラミング』は、具体的なコード例を見ながら学ぶ本ではありません。
本書にはコード例が一切登場せず、プログラミングにおける原則、思想、習慣、視点などが幅広く整理されています。
具体的なコードの書き方を学ぶというよりも、「良いプログラマーは何を考えているのか」を知るための読み物に近い本だと感じました。
すでに実務経験がある人にとっては、新しい発見が多いというより、これまで何となく感じていたことを言語化してくれる本かもしれません。
完全な初学者が最初に読むには少し抽象的かもしれませんが、文法をひと通り学び、実務に入り始めた人には良い地図になる本だと思います。
また、本書内で紹介されている関連書籍にも良書が多く、学びを広げるきっかけにもなる本だと感じました。
2冊目:リーダブルコード
『リーダブルコード』は、読みやすいコードを書くための王道の一冊です。
変数名、関数名、コメント、制御フロー、処理の分割など、日々コードを書くうえで気をつけるべきポイントが詰まっています。
この本の良いところは、内容がかなり実践的なところです。
書かれている内容は、そのままコードレビューでも使えます。
以前読んだときも学びはありましたが、実務でコードを書いたあとに読み返すと、以前よりも具体的に理解できる部分が増えたように感じました。
私も未だに定期的に読み返したくなる本です。
3冊目:良いコード/悪いコードで学ぶ設計入門
『良いコード/悪いコードで学ぶ設計入門』は、具体例が豊富で、設計の考え方をかなり丁寧に説明してくれる本です。
独特な表現が多く、人によっては少しクセを感じる部分もあるかもしれません。
ただ、悪いコードの例と、それをどう改善するかがセットで説明されているため、実務でありがちな問題に結びつけて理解しやすいです。
カプセル化などの解説はとても丁寧だと感じました。
変更に強いコード、責務分離、クラス設計などについて学びたい人にはおすすめしたい本です。
3冊に共通していたこと
この3冊で共通していたのは、コードを「ただ動けばよいもの」として扱わないということです。
コードはコンピュータに命令するためのものですが、同時に人間が読むものです。
- 読み手を意識すること
- 意図が伝わる名前をつけること
- 一つの処理に多くの責務を詰め込まないこと
- 変更に強い構造を意識すること
- 小さな違和感を放置しないこと
表現やアプローチはそれぞれ違いますが、根本にある考え方はかなり近いと感じました。
名前が曖昧だったり、処理が長すぎたり、責務が混ざっていたりすると、読む人の理解に時間がかかります。
そして、理解しにくいコードは修正もしにくくなり、結果的に変更への不安や手戻りにつながります。
そう考えると、良いコードを書くことは単なる美意識ではなく、プロジェクトを長く保つために必要な考え方だと思いました。
まとめ
この3冊は、それぞれ役割が異なると感じました。
- 『プリンシプル オブ プログラミング』は、プログラミングに向き合うための原則を学ぶ本
- 『リーダブルコード』は、読みやすいコードを書くための具体的な技術を学ぶ本
- 『良いコード/悪いコードで学ぶ設計入門』は、変更に強い設計を学ぶ本
良いコードについて学びたいなら、まず考え方を知り、次に読みやすさを学び、最後に設計へ進む流れが大切だと感じました。
紹介した書籍