Debug Klasse

Definition

Stellt eine Reihe von Methoden und Eigenschaften zum Debuggen von Code bereit.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
Vererbung
Debug

Beispiele

Im folgenden Beispiel wird Debug verwendet, um den Anfang und das Ende der Ausführung eines Programms anzugeben.The following example uses Debug to indicate the beginning and end of a program's execution. Im Beispiel wird außerdem Indent und Unindent verwendet, um die Ablauf Verfolgungs Ausgabe zu unterscheiden.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

Hinweise

Wenn Sie Methoden in der Debug -Klasse verwenden, um Debuginformationen zu drucken und ihre Logik mit Assertionen zu überprüfen, können Sie den Code robuster machen, ohne die Leistung und die Codegröße Ihres Versand Produkts zu beeinträchtigen.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.

Diese Klasse stellt Methoden bereit, um Assert ein Dialogfeld anzuzeigen und eine-Assertion auszugeben, die immer fehlschlägt.This class provides methods to display an Assert dialog box, and to emit an assertion that will always fail. Diese Klasse stellt Schreib Methoden in den folgenden Variationen bereit Write: WriteLine WriteIf , und WriteLineIf.This class provides write methods in the following variations: Write, WriteLine, WriteIf and WriteLineIf.

Die BooleanSwitch Klassen TraceSwitch und bieten die Möglichkeit, die Ablauf Verfolgungs Ausgabe dynamisch zu steuern.The BooleanSwitch and TraceSwitch classes provide means to dynamically control the tracing output. Sie können die Werte dieser Switches ändern, ohne die Anwendung neu zu kompilieren.You can modify the values of these switches without recompiling your application. Informationen zum Verwenden der Konfigurationsdatei zum Festlegen eines Schalters finden Sie im Switch Thema-Klasse und Ablauf Verfolgungs Schalter .For information on using the configuration file to set a switch, see the Switch class and the Trace Switches topic.

Sie können das Ziel der Ablauf Verfolgungs Ausgabe anpassen, TraceListener indem Sie Instanzen zu einer Auflistung hinzu Listeners fügen oder daraus entfernen.You can customize the tracing output's target by adding TraceListener instances to or removing instances from the Listeners collection. Die Listeners -Auflistung wird von der Debug -Klasse und Trace der-Klasse gemeinsam verwendet. durch das Hinzufügen eines Ablaufverfolgungslistener zu einer der beiden Klassen wirdThe Listeners collection is shared by both the Debug and the Trace classes; adding a trace listener to either class adds the listener to both. Standardmäßig gibt die DefaultTraceListener -Klasse die Ablauf Verfolgungs Ausgabe aus.By default, the DefaultTraceListener class emits trace output.

Hinweis

Das Listeners Hinzufügen eines Ablaufverfolgungslistener zur Auflistung kann dazu führen, dass während der Ablauf Verfolgung eine Ausnahme ausgelöst wird, wenn eine vom Ablaufverfolgungslistener verwendete RessourceAdding 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. Die Bedingungen und die ausgelöste Ausnahme hängen vom Ablaufverfolgungslistener ab und können in diesem Thema nicht aufgelistet werden.The conditions and the exception thrown depend on the trace listener and cannot be enumerated in this topic. Es kann nützlich sein Debug , Aufrufe der Methoden in try / catch -Blöcken zu platzieren, um Ausnahmen von Ablaufverfolgungslistenern zu erkennen und zu behandeln.It may be useful to place calls to the Debug methods in try/catch blocks to detect and handle any exceptions from trace listeners.

Sie können die Einzugs Ebene mithilfe der Indent -Methode oder der IndentLevel -Eigenschaft ändern.You can modify the level of indentation using the Indent method or the IndentLevel property. Verwenden Sie die IndentSize -Eigenschaft, um die Einzugs Abstände zu ändern.To modify the indent spacing, use the IndentSize property. Sie können angeben, ob der Ausgabepuffer nach jedem Schreibvorgang automatisch geleert werden soll AutoFlush , indem truedie-Eigenschaft auf festgelegt wird.You can specify whether to automatically flush the output buffer after each write by setting the AutoFlush property to true.

Zum Festlegen AutoFlush von und IndentSize für Debugkönnen Sie die Konfigurationsdatei bearbeiten, die dem Namen der Anwendung entspricht.To set the AutoFlush and IndentSize for Debug, you can edit the configuration file corresponding to the name of your application. Die Konfigurationsdatei sollte wie im folgenden Beispiel gezeigt formatiert werden.The configuration file should be formatted as shown in the following example.

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

Das ConditionalAttribute -Attribut wird auf die Methoden von Debugangewendet.The ConditionalAttribute attribute is applied to the methods of Debug. Compiler, die unter ConditionalAttribute stützen, ignorieren Aufrufe dieser Methoden, es sei denn, "Debug" ist als Symbol für die bedingte Kompilierung definiert.Compilers that support ConditionalAttribute ignore calls to these methods unless "DEBUG" is defined as a conditional compilation symbol. In der Dokumentation eines Compilers finden Sie Informationen ConditionalAttribute dazu, ob unterstützt wird, sowie die Syntax zum Definieren eines Symbols für die bedingte Kompilierung.Refer to a compiler's documentation to determine whether ConditionalAttribute is supported and the syntax for defining a conditional compilation symbol.

Hinweis

In Visual Studio C# und Visual Basic Projekten ist das Symbol für die bedingte Kompilierung "Debuggen" standardmäßig für Debugbuilds definiert, und das Symbol "Trace" wird sowohl für Debug-als auch für Releasebuilds definiert.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. Informationen dazu, wie Sie dieses Verhalten deaktivieren, finden Sie in der Visual Studio-Dokumentation.For information about how to disable this behavior, see the Visual Studio documentation. Weitere Informationen zum bedingten Debuggen C++in Visual finden Sie unter Debug-KlasseC++(/CLI).For information about conditional debugging in Visual C++, see Debug Class (C++/CLI).

Um das Symbol für die bedingte Kompilierung "Debuggen C#" /d:DEBUG in zu definieren, fügen Sie die-Option der Compilerbefehlszeile hinzu, wenn #define DEBUG Sie den Code mithilfe einer Befehlszeile kompilieren oder am Anfang der Datei hinzufügen.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. Fügen Sie in Visual Basic die /d:DEBUG=True -Option der Compilerbefehlszeile #Const DEBUG=True hinzu, oder fügen Sie der Datei hinzu.In Visual Basic, add the /d:DEBUG=True option to the compiler command line or add #Const DEBUG=True to the file.

Eigenschaften

AutoFlush

Ruft einen Wert ab, der angibt, ob für Flush() nach jedem Schreibvorgang Listeners aufgerufen werden soll, oder legt diesen fest.Gets or sets a value indicating whether Flush() should be called on the Listeners after every write.

IndentLevel

Ruft die Einzugsebene ab oder legt diese fest.Gets or sets the indent level.

IndentSize

Ruft die Anzahl der Leerzeichen in einem Einzug ab oder legt diese fest.Gets or sets the number of spaces in an indent.

Listeners

Ruft die Auflistung der Listener ab, die die Debugausgabe überwachen.Gets the collection of listeners that is monitoring the debug output.

Methoden

Assert(Boolean)

Überprüft eine Bedingung. Wenn die Bedingung false ist, wird ein Meldungsfeld mit der Aufrufliste angezeigt.Checks for a condition; if the condition is false, displays a message box that shows the call stack.

Assert(Boolean, String)

Überprüft eine Bedingung. Wenn die Bedingung false ist, wird eine bestimmte Meldung ausgegeben, und ein Meldungsfeld mit der Aufrufliste wird angezeigt.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)

Überprüft eine Bedingung. Wenn die Bedingung false ist, werden zwei angegebene Meldungen ausgegeben, und ein Meldungsfeld mit der Aufrufliste wird angezeigt.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[])

Überprüft eine Bedingung. Wenn die Bedingung false ist, werden zwei angegebene Meldungen (einfach und formatiert) ausgegeben, und ein Meldungsfeld mit der Aufrufliste wird angezeigt.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()

Leert den Ausgabepuffer und ruft dann für jeden Listeners die Close-Methode auf.Flushes the output buffer and then calls the Close method on each of the Listeners.

Fail(String)

Gibt die angegebene Fehlermeldung aus.Emits the specified error message.

Fail(String, String)

Gibt eine Fehlermeldung und eine detaillierte Fehlermeldung aus.Emits an error message and a detailed error message.

Flush()

Leert den Ausgabepuffer und veranlasst das Schreiben der gepufferten Daten in die Listeners-Auflistung.Flushes the output buffer and causes buffered data to write to the Listeners collection.

Indent()

Erhöht den aktuellen IndentLevel um eins.Increases the current IndentLevel by one.

Print(String)

Schreibt eine Meldung, gefolgt von einem Zeilenabschluss, in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a message followed by a line terminator to the trace listeners in the Listeners collection.

Print(String, Object[])

Schreibt eine formatierte Zeichenfolge, gefolgt von einem Zeilenabschluss, in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a formatted string followed by a line terminator to the trace listeners in the Listeners collection.

Unindent()

Verringert den aktuellen IndentLevel um eins.Decreases the current IndentLevel by one.

Write(Object)

Schreibt den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungswachungen in der Listeners-Auflistung.Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.

Write(Object, String)

Schreibt einen Kategorienamen und den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

Write(String)

Schreibt eine Meldung in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a message to the trace listeners in the Listeners collection.

Write(String, String)

Schreibt einen Kategorienamen und eine Meldung in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a category name and message to the trace listeners in the Listeners collection.

WriteIf(Boolean, Object)

Schreibt den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.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)

Schreibt einen Kategorienamen und den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.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)

Schreibt eine Meldung in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteIf(Boolean, String, String)

Schreibt einen Kategorienamen und eine Meldung in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

WriteLine(Object)

Schreibt den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungswachungen in der Listeners-Auflistung.Writes the value of the object's ToString() method to the trace listeners in the Listeners collection.

WriteLine(Object, String)

Schreibt einen Kategorienamen und den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection.

WriteLine(String)

Schreibt eine Meldung, gefolgt von einem Zeilenabschluss, in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a message followed by a line terminator to the trace listeners in the Listeners collection.

WriteLine(String, Object[])

Schreibt eine formatierte Meldung, gefolgt von einem Zeilenabschluss, in die Ablaufverfolgungslistener in der Listeners-Auflistung.Writes a formatted message followed by a line terminator to the trace listeners in the Listeners collection.

WriteLine(String, String)

Schreibt einen Kategorienamen und eine Meldung in die Ablaufverfolgungsüberwachungen in der Listeners-Auflistung.Writes a category name and message to the trace listeners in the Listeners collection.

WriteLineIf(Boolean, Object)

Schreibt den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.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)

Schreibt einen Kategorienamen und den Wert der ToString()-Methode des Objekts in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.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)

Schreibt eine Meldung in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteLineIf(Boolean, String, String)

Schreibt einen Kategorienamen und eine Meldung in die Ablaufverfolgungslistener in der Listeners-Auflistung, wenn eine Bedingung true ist.Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

Gilt für:

Threadsicherheit

Dieser Typ ist threadsicher.This type is thread safe.

Siehe auch