エコリクコラム

DX推進を進める中で多くの人が開発に携わります。「良いコード」とは、性能、バグの少なさ、再利用性など、様々な指標で評価されますが、その中でも「リーダブルコード」は、誰が見ても理解しやすいコードを書くための重要な指針です。

リーダブルコードの基本概念

リーダブルコードは、コードを読む人が、その意図や機能を容易に理解できるようにするためのコーディング原則です。

書籍「リーダブルコード」で紹介されている基本的な原則は、意外なほどシンプルで直感的です。しかし、そのシンプルさが実際に実装する際には意外と難しいです。

わかりやすい名前を付ける

変数名や関数名は、できるだけその意味が明確に伝わるように命名します。例えば、calculateDataという名前よりも、calculateAverageScoreのように具体的な名前を付けることで、意図が伝わりやすくなります。名前をわかりやすくすることで、他の開発者がコードを読む際にすぐにその役割を理解でき、無駄な時間を削減することができます。

適切にコメントを使う

コメントは、コードの動作を補足するためのものであり、コード自体で伝えきれない「なぜ」を説明することにフォーカスします。また、コメントが冗長である場合はコードを簡潔にする努力をすることも大切です。

リーダブルコードは、コメントを書くべき箇所と書かない箇所についても具体的に言及しています。適切なコメントを使うことで、コードの背後にある意図や設計上の判断を後から見返す際に理解しやすくなります。

関数は短く、シンプルに

関数はできるだけ短く保ち、一つのことだけを行うようにするのが理想です。これにより、関数をテストしやすくし、理解もしやすくなります。例えば、複数の異なる処理を一つの関数に詰め込むのではなく、役割ごとに小さな関数に分割することが推奨されています。関数を小さく保つことで、バグの発見や修正も容易になり、コードの再利用性も向上します。シンプルな関数を使うことによって、コード全体の流れがスムーズになり、読み手が混乱することを防ぐことができます。

以下は書籍の内容から取りまとめたものになります。(※1　※2）

名前に情報を詰め込む

関数名や変数名に、その役割や性質を明確に示す情報を盛り込みます。

• 例：「getPage」よりも「fetchPage」、「tmp」よりも具体的な名前
• 単位や範囲を示す情報を追加：「start_ms」、「max_value」

誤解されない名前にする

• 限界値には「limit」ではなく「max」「min」を使用
• 範囲指定には「first」「last」を使用
• ブーリアン型には「is」「has」を使用

コメントは正確で簡潔に

1）コメントすべきでないこと

• コードから推測が容易なもの
• コメントのためのコメント
• 指示語の使用

2）コメントすべきこと

• コードの意図や背景
• TODOコメント
• 長い処理の要約

制御フローを読みやすくする

• 条件式の引数の並び順：左側「調査対象」、右側「比較対象」に統一
• if/elseブロック：肯定形を優先
• 関数から早く返す
• ネストを浅くする

巨大な式を分割する

• 説明変数、要約変数を利用

変数と読みやすさを考える

• 不要な変数の削除
• 変数のスコープを縮める

リーダブルコードは、コードの保守性、可読性、再利用性を高め、チーム開発におけるコミュニケーションを円滑にするために不可欠です。

DX推進はSX、GXを進める上でも重要です。継続的に学び、改善を重ねることで、より良いコードを書く力が身につき技術力もあがります。

「デジタル・IT専門職」の求人