Skip to Main Content
C# in a Nutshell, Second Edition
book

C# in a Nutshell, Second Edition

by Peter Drayton, Ben Albahari, Ted Neward
August 2003
Intermediate to advanced content levelIntermediate to advanced
928 pages
32h 1m
English
O'Reilly Media, Inc.
Content preview from C# in a Nutshell, Second Edition

Conditional Compilation

The presence or absence of the DEBUG and TRACE symbols tell the compiler how to handle calls to methods in the Debug and Trace classes. If the DEBUG or TRACE symbols are not defined, many of the method calls into the Debug and Trace classes are optimized away completely. This can be a desirable feature for your own types, and there are a number of ways to accomplish this with the .NET Framework and the C# language.

One option is to bracket the calls with #if/#endif preprocessor directives, as follows:

void DoWork( ) {
#if METHODCALL
  Debug.WriteLine("MethodCall", "Entering MyClass::DoWork");
#endif
  Console.WriteLine("Working...");
}

Compiling this function with /d:METHODCALL,DEBUG results in a call to Debug.WriteLine and a log of the method entry. The downside to this approach is using preprocessor directives such as this is arduous and error-prone, and the code quickly becomes unreadable.

An alternative is to use the ConditionalAttribute custom attribute. When placed on a method, this attribute instructs the C# compiler to conditionally omit calls to the method.

Using this approach we can define a reflection-driven logger, as follows:

public class Logger { [Conditional("METHODCALL")] public static void LogMethodCall( ) { StackFrame sf = new StackFrame(1); // Get preceding stack frame MethodBase mb = sf.GetMethod( ); // Get refl. info for method Type t = mb.DeclaringType; // Get refl. info for type string s = String.Format("Entering {0}::{1}", t.Name, mb.Name); ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

C# in a Nutshell

C# in a Nutshell

Ben Albahari, Ted Neward, Peter Drayton
C# 7.0 in a Nutshell

C# 7.0 in a Nutshell

Joseph Albahari, Ben Albahari
C# Cookbook, 2nd Edition

C# Cookbook, 2nd Edition

Jay Hilyard, Stephen Teilhet
C# Cookbook

C# Cookbook

Joe Mayo

Publisher Resources

ISBN: 0596005261Catalog PageErrata