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. В примере также используется Indent и Unindent для различения выходных данных трассировки.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 , WriteLineи WriteLineIf.This class provides write methods in the following variations: Write, WriteLine, WriteIf and WriteLineIf.

Классы BooleanSwitch иTraceSwitch предоставляют средства для динамического управления выводом трассировки.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 и. Добавление прослушивателя трассировки в любой из этих классов добавляет прослушиватель Listeners в оба.The 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 для Debug, можно изменить файл конфигурации, соответствующий имени приложения.To 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>  

Атрибут применяется к Debugметодам. ConditionalAttributeThe 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 C# Studio и 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#в, добавьте /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

Возвращает или задает число пробелов в отступе.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, выводит два указанных сообщения и отображает окно сообщения со стеком вызовов.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, выводит два сообщения (простое и отформатированное) и отображает окно сообщения со стеком вызовов.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()

Очищает выходной буфер, а затем вызывает метод Close на каждый Listeners.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 на единицу.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 на единицу.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)

Записывает значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.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)

Записывает имя категории и значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.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)

Записывает сообщение в слушатели трассировки в коллекции Listeners, если условие имеет значение true.Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteIf(Boolean, String, String)

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.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)

Записывает значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.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)

Записывает имя категории и значение метода ToString() объекта в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.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)

Записывает сообщение в слушатели трассировки в коллекции Listeners, если условие имеет значение true.Writes a message to the trace listeners in the Listeners collection if a condition is true.

WriteLineIf(Boolean, String, String)

Записывает имя категории и сообщение в прослушиватели трассировки в коллекции Listeners, если условие имеет значение true.Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

Применяется к

Потокобезопасность

Данный тип потокобезопасен.This type is thread safe.

Дополнительно