Debug クラス

定義

コードのデバッグを支援するメソッドとプロパティのセットを提供します。Provides a set of methods and properties that help debug your code.

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

次の例でDebugは、を使用して、プログラムの実行の開始と終了を示します。The following example uses Debug to indicate the beginning and end of a program's execution. また、この例IndentUnindentは、とを使用して、トレース出力を区別します。The example also uses Indent and Unindent to distinguish the tracing output.

// 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クラスのメソッドを使用してデバッグ情報を出力し、アサーションを使用してロジックを確認する場合は、出荷製品のパフォーマンスとコードサイズに影響を与えることなく、コードの堅牢性を高めることができます。If you use methods in the Debug class to print debugging information and check your logic with assertions, you can make your code more robust without impacting the performance and code size of your shipping product.

このクラスには、 Assertダイアログボックスを表示し、常に失敗するアサーションを出力するメソッドが用意されています。This class provides methods to display an Assert dialog box, and to emit an assertion that will always fail. このクラスはWrite、、 WriteIf 、およびWriteLineIfの各バリエーションでWriteLine書き込みメソッドを提供します。This class provides write methods in the following variations: Write, WriteLine, WriteIf and WriteLineIf.

クラスBooleanSwitchTraceSwitchクラスは、トレース出力を動的に制御する手段を提供します。The BooleanSwitch and TraceSwitch classes provide means to dynamically control the tracing output. これらのスイッチの値は、アプリケーションを再コンパイルせずに変更できます。You can modify the values of these switches without recompiling your application. 構成ファイルを使用してスイッチを設定する方法についてSwitchは、クラスとトレーススイッチに関するトピックを参照してください。For information on using the configuration file to set a switch, see the Switch class and the Trace Switches topic.

インスタンスをコレクションに追加TraceListenerしたり、 Listenersコレクションからインスタンスを削除したりすることで、トレース出力のターゲットをカスタマイズできます。You can customize the tracing output's target by adding TraceListener instances to or removing instances from the Listeners collection. コレクションは、 TraceクラスDebugとクラスの両方で共有されます。いずれかのクラスにトレースリスナーを追加すると、リスナーが両方に追加されます。 ListenersThe Listeners collection is shared by both the Debug and the Trace classes; adding a trace listener to either class adds the listener to both. 既定では、 DefaultTraceListenerクラスはトレース出力を出力します。By default, the DefaultTraceListener class emits trace output.

注意

Listeners コレクションにトレース リスナーを追加することで、トレース リスナーによって使用されるリソースが利用できない場合、トレース中に例外を発生させることになります。Adding a trace listener to the Listeners collection can cause an exception to be thrown while tracing, if a resource used by the trace listener is not available. 条件とスローされる例外は、トレース リスナーに依存し、このトピックで列挙することはできません。The conditions and the exception thrown depend on the trace listener and cannot be enumerated in this topic. トレース リスナーから例外を検出し、処理するために、Debug メソッドの呼び出しをtry / catchブロックに配置することができます。It may be useful to place calls to the Debug methods in try/catch blocks to detect and handle any exceptions from trace listeners.

インデントレベルは、 IndentメソッドIndentLevelまたはプロパティを使用して変更できます。You can modify the level of indentation using the Indent method or the IndentLevel property. インデント間隔を変更するには、 IndentSizeプロパティを使用します。To modify the indent spacing, use the IndentSize property. 各書き込みの後に、 AutoFlushプロパティをにtrue設定することによって、出力バッファーを自動的にフラッシュするかどうかを指定できます。You can specify whether to automatically flush the output buffer after each write by setting the AutoFlush property to true.

AutoFlush IndentSizeおよびを設定するには、アプリケーションの名前に対応する構成ファイルを編集します。DebugTo set the AutoFlush and IndentSize for Debug, you can edit the configuration file corresponding to the name of your application. 構成ファイルは、次の例に示すように書式設定する必要があります。The configuration file should be formatted as shown in the following example.

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

属性ConditionalAttributeは、のDebugメソッドに適用されます。The ConditionalAttribute attribute is applied to the methods of Debug. をサポートConditionalAttributeするコンパイラは、"DEBUG" が条件付きコンパイルシンボルとして定義されていない限り、これらのメソッドの呼び出しを無視します。Compilers that support ConditionalAttribute ignore calls to these methods unless "DEBUG" is defined as a conditional compilation symbol. がサポートされているかどうかConditionalAttribute 、および条件付きコンパイルシンボルを定義するための構文を確認するには、コンパイラのドキュメントを参照してください。Refer to a compiler's documentation to determine whether ConditionalAttribute is supported and the syntax for defining a conditional compilation symbol.

注意

Visual Studio C#と Visual Basic のプロジェクトでは、既定ではデバッグビルドに対して "debug" 条件付きコンパイルシンボルが定義されており、"TRACE" シンボルはデバッグビルドとリリースビルドの両方に対して定義されています。In Visual Studio C# and Visual Basic projects, by default, the "DEBUG" conditional compilation symbol is defined for debug builds, and the "TRACE" symbol is defined for both debug and release builds. この動作を無効にする方法については、Visual Studio のドキュメントを参照してください。For information about how to disable this behavior, see the Visual Studio documentation. ビジュアルC++での条件付きデバッグの詳細については、「 Debug クラスC++(/cli)」を参照してください。For information about conditional debugging in Visual C++, see Debug Class (C++/CLI).

でC#"DEBUG" 条件付きコンパイルシンボルを定義するには/d:DEBUG 、コマンドラインを使用してコードをコンパイルするときにコンパイラのコマンドラインに#define DEBUGオプションを追加するか、ファイルの先頭にを追加します。To define the "DEBUG" conditional compilation symbol in C#, add the /d:DEBUG option to the compiler command line when you compile your code using a command line, or add #define DEBUG to the top of your file. Visual Basic で、コンパイラの/d:DEBUG=Trueコマンドラインにオプションを追加するか#Const DEBUG=True 、ファイルにを追加します。In Visual Basic, add the /d:DEBUG=True option to the compiler command line or add #Const DEBUG=True to the file.

プロパティ

AutoFlush

書き込むたびに、Flush()Listeners を呼び出すかどうかを示す値を取得または設定します。Gets or sets a value indicating whether Flush() should be called on the Listeners after every write.

IndentLevel

インデント レベルを取得または設定します。Gets or sets the indent level.

IndentSize

1 つのインデントに含まれるスペースの数を取得または設定します。Gets or sets the number of spaces in an indent.

Listeners

デバッグ出力を監視するリスナーのコレクションを取得します。Gets the collection of listeners that is monitoring the debug output.

メソッド

Assert(Boolean)

条件をチェックします。条件が false の場合、呼び出し履歴を見せるメッセージ ボックスを表示します。Checks for a condition; if the condition is false, displays a message box that shows the call stack.

Assert(Boolean, String)

条件をチェックします。条件が false の場合、指定したメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。Checks for a condition; if the condition is false, outputs a specified message and displays a message box that shows the call stack.

Assert(Boolean, String, String)

条件をチェックします。条件が false の場合、指定した 2 つのメッセージを出力し、コール スタックを示すメッセージ ボックスを表示します。Checks for a condition; if the condition is false, outputs two specified messages and displays a message box that shows the call stack.

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

条件をチェックし、その条件が false の場合は、2 つのメッセージ (単純なメッセージと書式設定されたメッセージ) を出力し、呼び出し履歴を表示するメッセージ ボックスを表示します。Checks for a condition; if the condition is false, outputs two messages (simple and formatted) and displays a message box that shows the call stack.

Close()

出力バッファーをフラッシュしてから、各 ListenersClose を呼び出します。Flushes the output buffer and then calls the Close method on each of the Listeners.

Fail(String)

指定されたエラー メッセージを出力します。Emits the specified error message.

Fail(String, String)

エラー メッセージと詳細エラー メッセージを出力します。Emits an error message and a detailed error message.

Flush()

出力バッファーをフラッシュし、バッファー内のデータを Listeners コレクションに書き込みます。Flushes the output buffer and causes buffered data to write to the Listeners collection.

Indent()

現在の IndentLevel を 1 だけ大きくします。Increases the current IndentLevel by one.

Print(String)

Listeners コレクションのトレース リスナーにメッセージを書き込み、続けて行終端記号を書き込みます。Writes a message followed by a line terminator to the trace listeners in the Listeners collection.

Print(String, Object[])

Listeners コレクションのトレース リスナーに書式指定された文字列を書き込み、続けて行終端記号を書き込みます。Writes a formatted string followed by a line terminator to the trace listeners in the Listeners collection.

Unindent()

現在の IndentLevel を 1 だけ減らします。Decreases the current IndentLevel by one.

Write(Object)

オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.

Write(Object, String)

カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

Write(String)

Listeners コレクションのトレース リスナーにメッセージを書き込みます。Writes a message to the trace listeners in the Listeners collection.

Write(String, String)

カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and message to the trace listeners in the Listeners collection.

WriteIf(Boolean, Object)

条件が true の場合、オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

WriteIf(Boolean, Object, String)

条件が true の場合は、カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

WriteIf(Boolean, String)

条件が true である場合、メッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteIf(Boolean, String, String)

条件が true である場合、カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

WriteLine(Object)

オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.

WriteLine(Object, String)

カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

WriteLine(String)

Listeners コレクションのトレース リスナーにメッセージを書き込み、続けて行終端記号を書き込みます。Writes a message followed by a line terminator to the trace listeners in the Listeners collection.

WriteLine(String, Object[])

Listeners コレクションのトレース リスナーに書式指定されたメッセージを書き込み、続けて行終端記号を書き込みます。Writes a formatted message followed by a line terminator to the trace listeners in the Listeners collection.

WriteLine(String, String)

カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and message to the trace listeners in the Listeners collection.

WriteLineIf(Boolean, Object)

条件が true の場合、オブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

WriteLineIf(Boolean, Object, String)

条件が true の場合は、カテゴリ名とオブジェクトの ToString() メソッドの値を Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

WriteLineIf(Boolean, String)

条件が true である場合、メッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteLineIf(Boolean, String, String)

条件が true である場合、カテゴリ名とメッセージを Listeners コレクションのトレース リスナーに書き込みます。Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

適用対象

スレッド セーフ

この型はスレッド セーフです。This type is thread safe.

こちらもご覧ください