はじめに
こんにちは！ITベンチャー企業で半年間働いている駆け出しエンジニアです👨💻
今回はコードレビューの質向上のためにリーダブルコードを読んでみました。
さて、初心者の僕のコードレビューの質は変わったのか見ていきましょう。
※ある程度本の内容は伏せています。詳しくは購入してお読みください！
本のタイトル
著者名と情報
- 著者名：Dustin Boswell(ダスティン・ボズウェル)
- 情報：サーカスで育てられたが、アクロバットよりコンピュータが向いていることに気づいて、カリフォルニア工科大学で理学士号を取得。コンピュータサイエンスに夢中になる。その後、カリフォルニア大学サンディエゴ校で修士号を取得。Google社で5年間勤務し、ウェブクローリング用のインフラなどさまざまなプロジェクトに携わる。現在は、インターネットスタートアップ企業が大好きで、暇なときにはサンタモニカ山地をハイキングしている。新米パパ。
- 著者名：Trevor Foucher(トレバー・フォシェ)
- 情報：10年以上もの間、Microsoft社でWindows 2000やOneCare、Google社でWebmaster Toolsなどのソフトウェアプロジェクトを送り出してきた。現在は独立コントリビュータ・マネージャ・テクニカルリードである。コードを読みやすく信頼できるものにすることが目標だ。
なぜこの本にしたのか
- 先輩プログラマーに死ぬほど押されたため
- どのブログでも名著だと書かれており、ほんとぉ？👶と思い自分の目で確かめることにした
目標
- コードレビューの質の向上
- コードを書く前にきれいなコードを意識して書けるようになること
本の概要
1章 理解しやすいコード
2章 名前に情報を詰め込む
3章 誤解されない名前
4章 美しさ
5章 コメントすべきことを知る
6章 コメントは正確で簡潔に
7章 制御フローを読みやすくする
8章 巨大な式を分割する
9章 変数と読みやすさ
10章 コードの再構成
11章 一度に1つのことを
12章 コードに思いを込める
13章 短いコードを書く
14章 テストと読みやすさ
15章 「分／時間カウンタ」を設計・実装する
内容の詳細や特筆すべき点
- コードを他の人が最短で理解できるように書く方法が書いてある
- 他の誰かが自分のコードを理解しやすいか考えるのは決して楽で簡単なことではないが、取り組むことに価値がある
著者のアプローチやスタイル
- 楽しく気軽に読んでほしい
読んで得た学びや気づき
- 説明変数という存在を知った
- 伝わる変数名の大切さに気づけた
- 現時点で理解できる部分とできない部分に差があった
実践への応用や実際の役立ち具合
- 説明変数を意識して書けるようになった
- コードの形を統一するよう意識するようになった
- 1度に１つタスクを行ってるかを意識して書けるようになった
- 関数を考えるときに最初にタスクを分解してみるようになった
おすすめの読者層
- プログラミングするすべての人
- コードレビュー初心者
- チーム開発する方(個人開発だから読まなくていいやではない)
おわりに
まず初学者は読みやすいコードを書く"意識"を持つことが大切だということがわかりました。
良いコードとは他人が読みやすいコードであるという、良いコードの概念を整理することができたのも一つ大きな一歩だと思います。
この意識をチーム全体で持つことが大事だということがわかりました。
今後も読みやすいコードの書き方に困ったらこの本を参考にコードレビューに取り組もうと思います。
うおー！🐹🖥
Discussion