はじめまして。
2025年1月より未経験からITエンジニアとして働き始めた、マル太です。
未経験からのスタートなので、毎日が勉強です。
現在、エンジニアの必読書と言われる「リーダブルコード」を読んでいます。
この本は、「読みやすいコード」の書き方を教えてくれる本です。
正直なところ、作中のコードの内容については十分理解できていませんが。。。
まずは一通り本書を読んでみようと思い、本書を読み進める中で、
「初心者の私にも役立つ情報がたくさんある」と感じたので、Qiitaにまとめてみることにしました。
同じように未経験からエンジニアになった方の参考になれば幸いです。
今回は、第1章「理解しやすいコード」の内容を、私なりにまとめてみます。
読みやすいコードを書くことはなぜ重要なのか
1章では、「コードは読みやすく書くべきである」と述べられています。
なぜなら、プログラミングでは、コードを読む時間の方が、書く時間よりもずっと多いからです。
他の人が書いたコードを読むのはもちろん、自分が過去に書いたコードを読み返すことも頻繁にあります。
もしコードが読みにくかったら、どうなるでしょうか？
・理解するのに時間がかかってしまいます。
・バグを見つけるのが難しくなってしまいます。
読みやすいコードを書くためのポイント
1章では、読みやすいコードを書くためのポイントとして、以下の点が挙げられています。
・変数や関数には分かりやすい名前をつける
変数や関数に名前をつけるときは、aやbのような、意味のわからない名前は避けましょう。
user_nameやtotal_priceのように、どんな値が入っているのか、ひと目でわかる名前をつけましょう。
※変数って？
変数とは、値を格納するための箱のようなものです。
例えば、user_nameという変数には、「山田太郎」さんのようなユーザーの名前を格納することができます。
変数名は、その箱に何が入っているのかを表すラベルのような役割を果たします。
※関数って？
関数は、特定の処理をまとめて名前を付けたものです。
例えば、商品の合計金額を計算する処理のコードを記述し、calculate_total_price()という関数にまとめることができます。
関数を使い分けることで、コードを整理し、再利用性を高めることができます。
・コメントをうまく使う
コードだけだと分かりにくいところは、コメントで説明しましょう。
ただし、コメントでコードの動きをすべて説明するのは適切ではありません。
そもそもコード自体が分かりやすくなるように、名前、構造、処理の順番などを工夫しましょう。
※コメントって？
コメントは、コードの動作や意図を説明するためのメモ書きのようなものです。
プログラミング言語によって書き方が異なりますが、//や#などの記号を使って記述します。
例えば、// この関数は、ユーザーの年齢を計算しますのような感じです。
・インデントを揃える
インデントを揃えると、コードの構造が整理されて見やすくなります。
※インデントって？
インデントとは、行頭に空白を入れて、コードを字下げすることです。
インデントを使うことで、コードの構造を視覚的に表現し、読みやすくすることができます。
・空白行を入れる
適度に空白行を入れると、コードが読みやすくなります。
まとめ
今回は、「リーダブルコード」の1章を、初心者なりにまとめてみました。
まだコードの内容を完全に理解するのは難しいですが、「リーダブルコード」を読んで、読みやすいコードを書くことの重要性を改めて認識しました。
これからエンジニアとして、読みやすいコードを心がけ、
質の高いシステム開発に貢献していきたいと思っています。
次回は、2章「名前に情報を詰め込む」についてまとめます。