先生と生徒の会話形式で理解しよう

生徒

プログラミングをしていて、自分の書いた命令が正しく動いているか確認する方法はありますか？

先生

C#には、プログラムの途中でメッセージを表示させて、動作を確認する「デバッグログ」という仕組みがあります。

生徒

画面に文字を出す方法なら聞いたことがありますが、デバッグ専用の方法もあるのでしょうか？

先生

その通りです！一般的に使われるConsole.WriteLineと、開発中に便利なDebug.WriteLineという二つの方法について詳しく解説しましょう。

1. プログラミングにおけるデバッグとは？

プログラミングの世界では、プログラムが思い通りに動かない原因（バグ）を見つけ出し、修正することをデバッグと呼びます。バグとは「虫」という意味で、昔の巨大なコンピューターの中に本物の虫が入り込んで故障させたことが語源と言われています。

初心者のうちは、コードを書いて実行しても「なぜかエラーが出る」「計算結果が予想と違う」という場面に必ず遭遇します。そんなとき、コンピューターが今何をしているのか、変数のなかにどんな数字が入っているのかを「見える化」するために出力するのがデバッグログです。これはいわば、プログラムが残す足跡のようなものです。

2. Console.WriteLineの基本的な使い方

C#で最も有名なログ出力方法がConsole.WriteLineです。これは「コンソール」という文字入出力専用の画面に、指定した文字列や数字を表示し、最後に改行を行う命令です。パソコンを触ったことがない方でも、黒い画面に白い文字が出ている状態を見たことがあるかもしれませんが、あそこに文字を出すための基本的な命令です。

まずは、画面に挨拶を表示するシンプルなコードを見てみましょう。この命令を使うことで、プログラムがその行まで無事にたどり着いたことを確認できます。


using System;

class Program
{
    static void Main()
    {
        // 画面にメッセージを表示します
        Console.WriteLine("プログラミングの世界へようこそ！");
        Console.WriteLine("これは1行目のログです。");
    }
}

上記のコードを実行すると、次のような結果が表示されます。


プログラミングの世界へようこそ！
これは1行目のログです。

3. Debug.WriteLineとは？Consoleとの違い

次に紹介するのがDebug.WriteLineです。名前に「Debug」と入っている通り、これは開発者がプログラムを修正したりテストしたりする目的で作られた命令です。Console.WriteLineとの最大の違いは、どこに表示されるかといつ動くかにあります。

Console.WriteLineは、完成したソフトを動かしたときにも利用者の画面に表示されますが、Debug.WriteLineは、Visual Studioなどの開発ツールにある「出力ウィンドウ」という場所にしか表示されません。また、製品として完成品（リリース版）を作成したときには、この命令は自動的に無視されるようになっています。つまり、開発中だけに見える「内緒のメモ」のような使い方ができるのです。

4. 変数の中身を表示して動作を確認する

デバッグログの真価は、計算の途中経過を確認することにあります。例えば、足し算の結果が正しいかどうかを確認したい場合、変数（データを一時的に入れておく箱のようなもの）の中身をログとして出力します。ここでは、数字を扱う変数を使って、計算結果を確認するコードを書いてみましょう。


using System.Diagnostics; // Debugを使うために必要です

int applePrice = 150;
int count = 3;
int total = applePrice * count;

// 計算結果が正しいかデバッグログで確認
Debug.WriteLine("リンゴの単価: " + applePrice);
Debug.WriteLine("個数: " + count);
Debug.WriteLine("合計金額の計算結果: " + total);

このコードを動かすと、開発ツールの出力画面に以下のように表示されます。これにより、プログラムが正しく150かける3を計算して450という結果を出していることがわかります。


リンゴの単価: 150
個数: 3
合計金額の計算結果: 450

5. 条件分岐とログ出力を組み合わせる

プログラムが複雑になると、「もし～ならAの処理をする」といった条件分岐が多くなります。自分の想定通りに分岐が進んでいるかを確認するために、ログを仕込む手法は非常に有効です。例えば、テストの点数によって合格か不合格かを判定するプログラムで、どちらの道を通ったのかをログに残してみましょう。


int score = 85;

if (score >= 80)
{
    Console.WriteLine("合格ルートに入りました。");
    Console.WriteLine("点数: " + score);
}
else
{
    Console.WriteLine("不合格ルートに入りました。");
}

このように、各分岐の中にConsole.WriteLineを入れておくことで、後からログを見たときに「今回は85点だったから、しっかり合格ルートを通ったんだな」と納得することができます。もし何も表示されないと、プログラムがどこで迷子になっているのか分からなくなってしまいます。

6. 文字列補完を使った見やすいログの書き方

C#には、文字列の中に変数を埋め込む便利な書き方があります。これを「文字列補完」と呼びます。これを使うと、複数の変数を一度にログに出したいときに、コードがスッキリして読みやすくなります。初心者の方こそ、この書き方を覚えるとデバッグ作業がぐっと楽になります。

書き方は簡単で、文字列の始まりのダブルクォーテーションの前に「$」を付け、変数を中括弧で囲むだけです。実際の例を見てみましょう。


string userName = "たろう";
int level = 10;

// $を使った便利な書き方
Console.WriteLine($"プレイヤー名: {userName} 現在のレベル: {level}");

// 昔ながらの書き方（比較用）
// Console.WriteLine("プレイヤー名: " + userName + " 現在のレベル: " + level);

実行結果は以下のようになります。プラス記号で文字をつなげるよりも、文章の形が分かりやすいので、複雑なログを出したいときに重宝します。


プレイヤー名: たろう 現在のレベル: 10

7. 開発効率を上げるログ出力のコツ

ログをたくさん出力すれば良いというわけではありません。画面がログで埋め尽くされると、本当に必要な情報を見逃してしまうからです。デバッグを効率的に進めるためのポイントをいくつか紹介します。

まず一つ目は、出力するメッセージに「何についてのログか」を明記することです。単に数字だけを表示すると、後で見たときにその数字が何を表しているのか分からなくなります。必ず「合計スコア: 500」のようにラベルを付けましょう。二つ目は、エラーが発生しそうな場所に重点的に配置することです。データの読み込みや複雑な計算の直後などにログを置くことで、問題の切り分けがスムーズになります。三つ目は、不要になったConsole.WriteLineは削除するか、コメントアウト（プログラムとして動かないように無効化すること）することです。これにより、製品版の動作が重くなるのを防ぐことができます。

8. デバッグ出力が表示されない時のチェックリスト

「コードを書いたのに、ログが表示されない！」というトラブルは初心者に非常に多いです。そんなときは、以下の項目を順番に確認してみましょう。

まず、Debug.WriteLineを使っている場合、Visual Studioの「出力」ウィンドウが開いているか確認してください。また、出力ウィンドウ内の設定が「デバッグ」になっているかどうかも重要です。次に、プログラム自体がその行に到達しているかを確認します。もし手前の条件分岐で弾かれているなら、そのログは一生実行されません。最後に、using System.Diagnostics;という一文がファイルの先頭に書かれているかチェックしてください。これがないと、コンピューターは「Debugって何？」と困ってしまいます。こうした基本的な確認を繰り返すことで、パソコンの操作やプログラミングの構造に少しずつ慣れていくことができます。