※本サイトで紹介している商品・サービス等の外部リンクには、アフィリエイト広告が含まれる場合があります。
こんにちは、やなっぎです。
アーリーステージからメガベンチャーまでWebエンジニアとして10年以上活動しています。
「読みやすいコード」ってどうやって書くんだろう?
そういう時は、名著の「リーダブルコード」を読んでみるといいかも
「読みやすいコードを書きたい」、「コードレビューで命名やコード構成の指摘をよくもらう」ということはないでしょうか。
プログラミング初心者の方にとって、可読性が高いコードを書くのはなかなか大変なことです。
そんな時は、「リーダブルコード」が役立ちます。
「リーダブルコード」を読むことで、読みやすいコードを書く実践的なテクニックを学ぶことができます。
書籍内では、良いコードと悪いコードのサンプルが随所に散りばめられており、プログラミング初心者の方も理解しやすい形式になっています。
ぜひ、「リーダブルコード」を読んで、バグが少なく変更もしやすい保守性の高いコードを書けるスキルを身につけましょう。
目次
「リーダブルコード」で理解しやすいコードを書く
「リーダブルコード」の目的は、読みやすいコードを書くことです。
読みやすいコードは、他の人がソースコードを読んで、より短時間で理解ができるコードのことです。
コードは理解しやすくなければならない。
これがコードを書くうえでいちばん大切な原則だ。
(引用元:リーダブルコード 1章 理解しやすいコード)
ソースコードの規模が大きくなればなるほど、コードを書いている時間よりも読んでいる時間のほうが長くなります。
より短い時間でコードを理解できると、既存コードを変更しやすくなり、バグも埋め込みづらくなります。その結果として、よりスピーディに高品質なソフトウェアを開発できるようになります。
いわゆるスパゲッティコードみたいなソースコードだと、既存のコードを理解するのが大変だよね
どこを変更すればよいか分からないし、変更した結果としてバグが発生しないか確認するのも大変だから…
「リーダブルコード」は可読性の高いコードを書くテクニックが学べる
「リーダブルコード」では可読性の高いコードを書く実践的なテクニックを学ぶことができます。
書籍の構成としては、
- 1部 表面上の改善
- 2部 ループとロジックの単純化
- 3部 コードの再構成
という流れになっています。
はじめは、変数名の付け方や空行や空白の使い方などコードの断片から始まり、次第にコード全般の構成と広がっていきます。
「リーダブルコード」の良い点・悪い点の感想
改めて「リーダブルコード」を読み直したのですが、2012年に発売された本ですが今も色褪せず現場でも使える内容になっています。
若手のエンジニアのコードをレビューをするときには、リーダブルコードをを引用しながらコメントをすることはあるよ!
ベテランのエンジニアにとっては、普段からコードを書くときに意識している内容ばかりなので学べることは少ないでしょう。
しかし、逆にいうと、未経験から実務経験3年目ぐらいまでの若手のエンジニアにとっては得るものがたくさんあります。
ベテランエンジニアがコードを書くときに意識しているテクニックを効率的に学ぶことができるからです。
- 明確で誤解されない名前を選ぶ
- 一貫性のあるレイアウトで綺麗なコードを書く
- 関連するコードはブロックでまとめる
- 読み手の立場に立って必要なコメントを書く
- 条件やループはシンプルにする
- ネストが深くならないように早期リターンをする
- 変数のスコープは短くする
- 一度に1つのタスクをする
- メソッド内の処理の粒度を合わせる
- などなど
こういったテクニックを実際のソースコードを見ながら学べます。
リーダブルコードの1つの欠点として、リンタやフォーマッタという話題が取り上げられていません。
最近のほとんどのプロジェクトでは、ESLintやRubocopなどのプログラミング言語に合わせたリンタやフォーマッタを使っており、複数人で開発をしても可読性の高いコードを維持できる便利なツールです。
リンタやフォーマッタを活用しつつも、リーダブルコードで書かれているテクニックを意識すれば鬼に金棒の状態と言えるでしょう!
「リーダブルコード」がおすすめな人
リーダブルコードがおすすめな人は次のとおりです。
- プログラミング初心者で良いコードを書きたい人
- コードレビューで命名やコード構成で指摘を受ける人
- もっと綺麗なコードを書きたい人
若手のエンジニアのコードレビューでは、同じようなコメントが繰り返されます。
- メソッド名と実態が合っていないのでメソッド名を変えましょう
- メソッドが大きすぎて処理の流れを追うのが大変なのでメソッドを分割しましょう
- ネストが深くて読みづらいので、、早期リターンでネストを減らしましょう
こういった指摘の大抵の答えは「リーダブルコード」にすでに書かれています。
先駆者が「ひどいコード」をたくさん集め、なぜそのコードがひどいのか、どんな原則やテクニックを使うことで読みやすいコードになるのかといったことが書かれています。
「リーダブルコード」はベテランには当たり前の内容ですが、若手エンジニアにとってはなかなか理解するのが難しいです。意識しているけど、なかなか改善できないこともあるでしょう。
こういう本は一度読んで終わりではなく、経験を積んだ後に読み返すと自分の成長を実感できます。
レビューでコードの可読性に関する指摘が指摘が多い読みやすいコードを書きたい人は、
リーダブルコード ?より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice) 中古価格 |