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 プログラムの実行の開始と終了を示します。 また、この例では、とを使用して、 Indent Unindent トレース出力を区別します。

// 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 、ダイアログボックスを表示し、常に失敗するアサーションを出力するメソッドが用意されています。 このクラスは Write 、、 WriteLineWriteIf およびの各バリエーションで書き込みメソッドを提供し WriteLineIf ます。

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

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

注意

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

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

のおよびを設定するには AutoFlush IndentSize Debug 、アプリケーションの名前に対応する構成ファイルを編集します。 構成ファイルは、次の例に示すように書式設定する必要があります。

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

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

注意

C# および Visual Basic プロジェクトでは、デバッグビルドに対して "デバッグ" 条件付きコンパイルシンボルが既定で定義されており、"トレース" シンボルがデバッグビルドとリリースビルドの両方に対して定義されています。 Visual Studio この動作を無効にする方法の詳細については、Visual Studio のドキュメントを参照してください。 Visual C++ での条件付きデバッグの詳細については、「 Debug クラス (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)

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

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

カテゴリ名とメッセージを 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 コレクションのトレース リスナーに書き込みます。

適用対象

スレッド セーフ

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

こちらもご覧ください