就職対策Vo.099～「リーダブルコード(読みやすいコード)」とは何か？
キャリアコンサルタントのサイトウです。今回は、リーダブルコードについてを話をしていきましょう。
リーダブルコードとは、多くの開発者から支持を受け、読み継がれてきた書籍です。
書籍の冒頭にこう書いてあります。
「美しいコードを見ると感動する。優れたコードは見た瞬間に何をしているかが伝わってくる。そういうコードは使うのが楽しいし、自分のコードもそうあるべきだと思わせてくれる。本書の目的は、君のコードを良くすることだ。」
この中にある、君のコードを良くするとはどのような意味なのでしょうか？
書籍では、「良いコードを書くためのシンプルで実践的なテクニック」を紹介しています。
今回は、分かりやすく解説をしていきましょう！
●悪い(良くない)コードとは？
良いコードとは何かを理解するため、悪いコードを考えてみましょう。
悪い(良くない)コードの特徴として3つを上げます。
・読みづらい
・どう動いているか不明
・見た瞬間・・・
あなたは、他人が来たコードを見た時に、このように感じたことはないでしょうか？
これに該当するコードは、悪い(良くない)コードといえます。
●良いコードとは？
悪い(良くない)コードの対極にあたるのが、良い(読みやすいコード)コード」です。
このコードが書けるようになると、自分以外の人も理解しやすく、チーム開発効率が上がり、バグも少なくなります。
●チーム開発
チームで開発をする場合は、自分以外もコードを理解できていないといけません。
理解するとはどのようなことなのでしょうか？
書籍の中ではこのように書かれています。
「コードを理解する」というのは、変更を加えたりバグを見つけたりできるという意味だ。他のコードと連携する方法も理解しておかなければいけない。
チーム開発の場合は、他人が書いたコードを改修することが多くあります。
そのため、誰でも手を加えられる状態になっているかどうかが重要です。
これができていないと、開発スピードが低下していき、プロジェクト全体に影響が出てきます。
これを防ぐためには、できるだけ小さく軽量な、良いコードが書くことが必要です。
●理解しやすくする
理解しやすくするためには、具体的にどのようなことが必要なのでしょうか？
【変数名】
・具体的な情報
読んで意味がはっきり通る単語を変数名に使うだけで、コードを読む人へのメッセージになります。
・省略形
省略形を使用することは推奨されていますが、プロジェクト外でも広く使われている省略形に限ります。
プロジェクト独自の省略形は避けるべきです。
なぜならば、新しいメンバーが入った時に、理解できるかが不透明だからです。
もし、使用する場合は、多用せずに、共有することが必要です。
・変数のスコープを縮める
書籍の中では、変数のことが見えるコード行数をできるだけ減らすことを推奨していますが、それはなぜでしょうか？
それは、一度に考えなければいけない変数を減らせるからです。
コードを読む時間を減らすことで効率化を図ることができるのですね！
●式と関数
同じ言語でも、書き方は様々です。
だからといって、それぞれが違った書き方をしてしまうと、理解がしにくくなります。
個人が好き勝手に書くのではなく、チームで統一することが大事といえます。
●関数を分割
一般的には、大きすぎる関数はできるだけ使用せず、小さな関数に分割すべきといわれています。
そうすることで、1つの処理ごとに適切に分割することができ、全体を理解するまでのスピードが上がります。
●一貫性
書籍では、一貫性のあるスタイルは「正しい」スタイルよりも大切であるとされています。
もし、あながた間違っていると感じても、プロジェクト内で一貫性を保つことを心がることが大事です。
良いコードの書きかたは理解できましたか？
すぐに完璧なスキルを身につけるのは難しいと思いますので、先輩や上司からのコードレビューなどを行い、スキルアップしていってください！
