Debug クラス

定義

コードのデバッグを支援するメソッドとプロパティのセットを提供します。

public ref class Debug abstract sealed
public ref class Debug sealed
public static class Debug
public sealed class Debug
type Debug = class
Public Class Debug
Public NotInheritable Class Debug
継承
Debug

次の例では、 を使用 Debug して、プログラムの実行の開始と終了を示します。 この例では、 と Unindent も使用Indentしてトレース出力を区別します。

// Specify /DDEBUG when compiling.

#using <System.dll>
using namespace System;
using namespace System::Diagnostics;

int main( void )
{
   #if defined(DEBUG)
   Debug::Listeners->Add( gcnew TextWriterTraceListener( Console::Out ) );
   Debug::AutoFlush = true;
   Debug::Indent();
   Debug::WriteLine( "Entering Main" );
   #endif
   Console::WriteLine( "Hello World." );
   #if defined(DEBUG)
   Debug::WriteLine( "Exiting Main" );
   Debug::Unindent();
   #endif
   return 0;
}
// Specify /d:DEBUG when compiling.

using System;
using System.Data;
using System.Diagnostics;

class Test
{
    static void Main()
    {
       Debug.Listeners.Add(new TextWriterTraceListener(Console.Out));
       Debug.AutoFlush = true;
       Debug.Indent();
       Debug.WriteLine("Entering Main");
       Console.WriteLine("Hello World.");
       Debug.WriteLine("Exiting Main");
       Debug.Unindent();
    }
}
' Specify /d:DEBUG=True when compiling.

Imports System.Data
Imports System.Diagnostics

Class Test

    Shared Sub Main()
    
        Debug.Listeners.Add(New TextWriterTraceListener(Console.Out))
        Debug.AutoFlush = True
        Debug.Indent()
        Debug.WriteLine("Entering Main")
        Console.WriteLine("Hello World.")
        Debug.WriteLine("Exiting Main")
        Debug.Unindent()
        
    End Sub
    
End Class

注釈

出荷製品のパフォーマンスとコード サイズに影響を与えずにコードをより堅牢にするには、 クラスの メソッドDebugを使用してデバッグ情報を出力し、アサーションを使用してロジックをチェックします。

このクラスは、ダイアログ ボックスを Assert 表示し、常に失敗するアサーションを出力するメソッドを提供します。 このクラスは、次のバリエーションの書き込みメソッドを提供します。

クラスと TraceSwitch クラスはBooleanSwitch、トレース出力を動的に制御する手段を提供します。 .NET Framework アプリの場合は、アプリケーションを再コンパイルせずに、これらのスイッチの値を変更できます。 構成ファイルを使用して.NET Framework アプリでスイッチを設定する方法については、クラスとトレース スイッチに関する記事を参照してくださいSwitch

インスタンスをコレクションに追加 TraceListener するか、コレクションからインスタンスを削除することで、トレース出力のターゲットを Listeners カスタマイズできます。 コレクションはListeners、 クラスと クラスのTrace両方Debugで共有されます。いずれかのクラスにトレース リスナーを追加すると、リスナーが両方に追加されます。 既定では、 クラスは DefaultTraceListener トレース出力を出力します。

注意

Listeners コレクションにトレース リスナーを追加することで、トレース リスナーによって使用されるリソースが利用できない場合、トレース中に例外を発生させることになります。 条件とスローされる例外はトレース リスナーによって異なります。この記事では列挙できません。 トレース リスナーから例外を検出し、処理するために、Debug メソッドの呼び出しをtry/catchブロックに配置することができます。

インデントのレベルは、 メソッドまたは IndentLevel プロパティをIndent使用して変更できます。 インデント間隔を変更するには、 プロパティを使用します IndentSize 。 各書き込みの後に出力バッファーを自動的にフラッシュするかどうかを指定するには、 プロパティを AutoFlushtrue設定します。

.NET Framework アプリの場合は、アプリのAutoFlush構成ファイルを編集して、 と IndentSizeDebug設定できます。 構成ファイルは、次の例に示すように書式設定する必要があります。

<configuration>
  <system.diagnostics>
    <trace autoflush="true" indentsize="7" />
  </system.diagnostics>
</configuration>

属性は ConditionalAttribute 、 の メソッド Debugに適用されます。 をサポート ConditionalAttribute するコンパイラは、条件付きコンパイル シンボルとして定義されていない限り DEBUG 、これらのメソッドの呼び出しを無視します。 がサポートされているかどうかを ConditionalAttribute 判断するには、コンパイラのドキュメントと、条件付きコンパイル シンボルを定義するための構文を参照してください。

注意

Visual Studio C# プロジェクトと Visual Basic プロジェクトでは、既定では、 DEBUG 条件付きコンパイル シンボルはデバッグ ビルド用に定義され、シンボルはデバッグ ビルドと TRACE リリース ビルドの両方に対して定義されます。 Visual C++ での条件付きデバッグの詳細については、「 デバッグ クラス (C++/CLI)」を参照してください。

C# で条件付きコンパイル シンボルを DEBUG 定義するには、コマンド ラインを /d:DEBUG 使用してコードをコンパイルするときにコンパイラ コマンド ラインに オプションを追加するか、ファイルの先頭に を追加 #define DEBUG します。 Visual Basic で、コンパイラ コマンド /d:DEBUG=True ラインに オプションを追加するか、ファイルに を追加 #Const DEBUG=True します。

プロパティ

AutoFlush

書き込むたびに、Flush()Listeners を呼び出すかどうかを示す値を取得または設定します。

IndentLevel

インデント レベルを取得または設定します。

IndentSize

1 つのインデントに含まれるスペースの数を取得または設定します。

Listeners

デバッグ出力を監視するリスナーのコレクションを取得します。

メソッド

Assert(Boolean)

条件をチェックします。条件が false の場合、呼び出し履歴を見せるメッセージ ボックスを表示します。

Assert(Boolean, Debug+AssertInterpolatedStringHandler)

条件をチェックします。条件が false の場合、指定したメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。

Assert(Boolean, Debug+AssertInterpolatedStringHandler, Debug+AssertInterpolatedStringHandler)

条件をチェックします。条件が false の場合、指定したメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。

Assert(Boolean, String)

条件をチェックします。条件が false の場合、指定したメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。

Assert(Boolean, String, String)

条件をチェックします。条件が false の場合、指定した 2 つのメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。

Assert(Boolean, String, String, Object[])

条件をチェックし、その条件が false の場合は、2 つのメッセージ (単純なメッセージと書式設定されたメッセージ) を出力し、呼び出し履歴を表示するメッセージ ボックスを表示します。

Close()

出力バッファーをフラッシュしてから、各 ListenersClose を呼び出します。

Fail(String)

指定されたエラー メッセージを出力します。

Fail(String, String)

エラー メッセージと詳細エラー メッセージを出力します。

Flush()

出力バッファーをフラッシュし、バッファー内のデータを Listeners コレクションに書き込みます。

Indent()

現在の IndentLevel を 1 だけ大きくします。

Print(String)

Listeners コレクションのトレース リスナーにメッセージを書き込み、続けて行終端記号を書き込みます。

Print(String, Object[])

Listeners コレクションのトレース リスナーに書式指定された文字列を書き込み、続けて行終端記号を書き込みます。

Unindent()

現在の IndentLevel を 1 だけ減らします。

Write(Object)

オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

Write(Object, String)

カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

Write(String)

Listeners コレクションのトレース リスナーにメッセージを書き込みます。

Write(String, String)

カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

が の場合 conditiontrueカテゴリ名とメッセージをコレクション内のトレース リスナーに Listeners 書き込みます。

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

指定した条件trueが の場合、カテゴリ名とメッセージをコレクション内のListenersトレース リスナーに書き込みます。

WriteIf(Boolean, Object)

条件が true の場合、オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteIf(Boolean, Object, String)

条件が true の場合は、カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteIf(Boolean, String)

条件が true である場合、メッセージを Listeners コレクションのトレース リスナーに書き込みます。

WriteIf(Boolean, String, String)

条件が true である場合、カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。

WriteLine(Object)

オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteLine(Object, String)

カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteLine(String)

Listeners コレクションのトレース リスナーにメッセージを書き込み、続けて行終端記号を書き込みます。

WriteLine(String, Object[])

Listeners コレクションのトレース リスナーに書式指定されたメッセージを書き込み、続けて行終端記号を書き込みます。

WriteLine(String, String)

カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。

WriteLineIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

指定した条件trueが の場合、コレクション内のトレース リスナーにListenersメッセージを書き込みます。

WriteLineIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

指定した条件trueが の場合、カテゴリ名とメッセージをコレクション内のListenersトレース リスナーに書き込みます。

WriteLineIf(Boolean, Object)

条件が true の場合、オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteLineIf(Boolean, Object, String)

条件が true の場合は、カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。

WriteLineIf(Boolean, String)

条件が true である場合、メッセージを Listeners コレクションのトレース リスナーに書き込みます。

WriteLineIf(Boolean, String, String)

条件が true である場合、カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。

適用対象

スレッド セーフ

この型はスレッド セーフです。

こちらもご覧ください