CODEWITHSUNDEEP
c#.netdebugginginstrumentation
Ben Collins
Ben Collins

Reputation: 20686

Trace vs Debug in .NET BCL

It seems that the

are largely the same, with the notable exception that Debug usage is compiled out in a release configuration.

When would you use one and not the other? The only answer to this I've dug up so far is just that you use the Debug class to generate output that you only see in debug configuration, and Trace will remain in a release configuration, but that doesn't really answer the question in my head.

If you're going to instrument your code, why would you ever use Debug, since Trace can be turned off without a recompile?

Upvotes: 70

Views: 37219

Answers (7)

Cory Foy
Cory Foy

Reputation: 7222

You've answered your own question. If Debug messages stayed in, people could see them. For example, let's say you do:

Debug.WriteLine("Connecting to DB with username: blah and PW: pass");

Anyone who decompiles your code can see that. But that may be something vitally important for you to know during testing.

Trace is different. If you are going to do Trace, I'd likely just use log4net.

Upvotes: 1

Navid_pdp11
Navid_pdp11

Reputation: 4032

Full difference between Trace and Debug:

Both Debug and Trace use System.Diagnostics namespace.

Debug

  • It uses Debug class.
  • It uses in debug build.
  • It uses the time of application development.
  • In Debug mode compiler inserts some debugging code inside the executable.
  • Debug class works only in debug mode.
  • Performance analysis cannot be done using Debug.
  • Debugging uses to find error in program.
  • For Debug we can use Debug.Write() method.
  • Debug runs in same thread as main program execute.

Trace

  • It uses Trace class.
  • Trace statement includes by default when program compiled into released build.
  • Trace class is used for testing and optimization even after an application is compiled and released.
  • Trace class works in both case Debug mode as well as release mode.
  • Trace runs in different thread form main program execute thread.
  • For Trace we can use Trace.Write() method.
  • It uses time of application deployment.

Reference: C# Corner

Upvotes: 4

Raj
Raj

Reputation: 51

Debug is used to pure debugging purposes. It emits rich messages in debug execution (debug mode).

Trace helps in application debugging, bug fixing, and profiling (after release).

The Debug class is of no use in release mode.

Upvotes: 5

sandy101
sandy101

Reputation: 3427

The only difference between trace and debug is that trace statements are included by default in the program when it is compiled into a release build, whereas debug statement are not.

Thus, the debug class is principally used for debugging in the development phase, while trace can be used for testing and optimization after the application is compiled and released.

Upvotes: 5

Michael Burr
Michael Burr

Reputation: 340456

I'd look at using log4net for tracing as its capabilities are much more flexible and robust.

But for true debug messages that I never intend for anyone other than me or an internal tester to see, I'd probably stick with Debug.

Upvotes: 1

Kevin Dente
Kevin Dente

Reputation: 25738

For highly performance sensitive code blocks, leaving Trace compiled-in but disabled might make a performance difference.

Upvotes: 2

Jared
Jared

Reputation: 2015

The main difference is the one you indicate: Debug is not included in release, while Trace is.

The intended difference, as I understand it, is that development teams might use Debug to emit rich, descriptive messages that might prove too detailed (or revealing) for the consumer(s) of a product, while Trace is intended to emit the kinds of messages that are more specifically geared toward instrumenting an application.

To answer your last question, I can't think of a reason to use Debug to instrument a piece of code I intended to release.

Hope this helps.

Upvotes: 73

Related Questions