マジックナンバーとは？意味をわかりやすく簡単に解説

公開：2024年10月2日更新：2024年10月2日

マジックナンバーとは
マジックナンバーの問題点と対策
コードの可読性低下と理解困難
定数を用いた適切な命名方法
リファクタリングによる改善手法

マジックナンバーとは

プログラミングにおけるマジックナンバーとは、ソースコード内で直接使用される意味不明な数値のことです。これらの数値はコードの可読性を低下させ、保守性を損なう原因となる可能性があります。マジックナンバーの使用はプログラムの意図を理解しづらくし、将来的な変更や拡張を困難にする要因となるでしょう。

マジックナンバーの問題点はその数値が何を表しているのか、なぜその値が選ばれたのかが不明確なことにあります。コードを読む人にとってこれらの数値の意味や、目的を推測することは非常に困難です。そのためプログラムの動作を理解したりバグを修正したりする際、多くの時間と労力が必要となってしまいます。

マジックナンバーを避けるためには、意味のある定数や変数名を使用することが推奨されています。たとえば配列の最大サイズを表す数値であれば「MAX_ARRAY_SIZE」といった定数名を付けることで、コードの意図が明確になります。このような命名規則を採用することで、プログラムの可読性と保守性が大幅に向上するのです。

Python基礎・実践(Django)

企業・法人向けのPython研修では、基礎から応用まで体系的に学べます。

Python研修の詳細

DX社員研修

企業・法人向けのDX研修では、実務に繋がるリスキリングでITレベルを向上させます。

DX研修の詳細

Javaエンジニア育成研修

企業・法人向けのJavaエンジニア育成研修では、Javaの基礎から応用まで確実に習得できます。

Java研修の詳細

新卒・新入社員向け研修

企業・法人に新入社員・新卒社員に向けたプログラミング研修を提供しています。

新入社員研修の詳細

コードキャンプのIT研修を全て見る

マジックナンバーの問題点と対策

マジックナンバーの問題点と対策について、以下3つを簡単に解説します。

コードの可読性低下と理解困難
定数を用いた適切な命名方法
リファクタリングによる改善手法

コードの可読性低下と理解困難

マジックナンバーの使用はコードの可読性を著しく低下させ、プログラムの意図を理解することが困難になるのが問題点です。数値の意味や由来が不明確なときはほかの開発者や将来の自分がコードを読む際、その数値が何を表しているのかを把握するのに時間がかかります。これによりプロジェクト全体の生産性が低下し、バグの発見や修正が遅れる可能性が高くなります。

下記はマジックナンバーが使用されている例と、定数を用いて改善された例の比較です。

// マジックナンバーを使用した例
if (age > 20) {
    // 処理
}

// 定数を用いて改善した例
const int LEGAL_DRINKING_AGE = 20;
if (age > LEGAL_DRINKING_AGE) {
    // 処理
}

上記の例では20という数値が何を表しているのかが不明確でしたが、LEGAL_DRINKING_AGEという定数名を使用することでその意図が明確になりました。このような改善によってコードの可読性が大幅に向上し、他の開発者も容易に理解できるようになります。

おすすめのPython研修一覧

Python研修を提供しているおすすめの企業・法人を一覧で掲載しております。

Python研修の一覧を見る

おすすめのDX研修一覧

DX研修を提供しているおすすめの企業・法人を一覧で掲載しております。

DX研修の一覧を見る

おすすめのJava研修一覧

Java研修を提供しているおすすめの企業・法人を一覧で掲載しております。

Java研修の一覧を見る

おすすめのJavaScript研修一覧

JavaScript研修を提供しているおすすめの企業・法人を一覧で掲載しております。

JavaScript研修の一覧を見る

定数を用いた適切な命名方法

マジックナンバーの問題を解決するための効果的な方法は、適切な名前を付けた定数を使用することです。定数名はその値が表す意味や、目的を明確に示すものを選ぶことが重要です。たとえば配列の最大サイズを表す場合は「MAX_ARRAY_SIZE」、円周率を表す場合は「PI」といった具合に理解しやすい名前を付けることが望ましいでしょう。

下記は適切な定数の命名例です。これらの例を参考に、プロジェクトの文脈に合わせて命名を行うことが大切です。

const int MAX_ATTEMPTS = 3;
const double TAX_RATE = 0.08;
const string DEFAULT_USERNAME = "guest";
const int SECONDS_PER_DAY = 86400;

これらの定数を使用することでコード内の数値の意味が明確になり、ほかの開発者や将来の自分がコードを読む際にその意図を容易に理解できます。また、値の変更が必要になった場合も、定数の定義箇所を一箇所変更するだけで済むため保守性も向上するのです。

リファクタリングによる改善手法

既存のコードベースからマジックナンバーを除去し、より保守性の高いコードに改善するプロセスをリファクタリングと呼びます。リファクタリングの際はまずマジックナンバーを特定し、それぞれの数値が何を表しているのかを慎重に分析する必要があります。その上で適切な名前を付けた定数に置き換えていくのが一般的な手法です。

リファクタリングの具体的な手順は下記の通りです。