0 out of 1 rated this helpful - Rate this topic

DebuggerStepThroughAttribute Class

Updated: October 2010

Instructs the debugger to step through the code instead of stepping into the code. This class cannot be inherited.

System.Object
  System.Attribute
    System.Diagnostics.DebuggerStepThroughAttribute

Namespace:  System.Diagnostics
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Constructor|AttributeTargets.Method, Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class DebuggerStepThroughAttribute : Attribute

The DebuggerStepThroughAttribute type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library DebuggerStepThroughAttribute Initializes a new instance of the DebuggerStepThroughAttribute class.
Top
  Name Description
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Supported by the XNA Framework Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The common language runtime attaches no semantics to this attribute. It is provided for use by source code debuggers. For example, the Visual Studio 2005 debugger does not stop in a method marked with this attribute but does allow a breakpoint to be set in the method.

For more information about using attributes, see Extending Metadata Using Attributes.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Date

History

Reason

October 2010

Updated the class summary.

Customer feedback.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Behavior in Visual Studio 2010 is different than Visual Studio 2005
In Visual Studio 2010 the debugger ignores breakpoints in methods marked with DebuggerStepThroughAttribute. This is different than the behavior stated for VisualStudio 2005.
Properties are stepped by default
Properties are jumped over by default with Visual Studio.

http://msdn.microsoft.com/en-us/library/cc667388.aspx

To disable stepping into properties and operators

  1. On the Tools menu, click Options.

  2. In the Options dialog box, click Debugging from the box on the left side.

  3. In the General box, select the Step over properties and operators (Managed only) check box.

  4. Click OK.

Applying [DebuggerStepThroughAttribute] to properties

When applying this attribute to properties, you will get compiler errors.

[DebuggerStepThrough]
public int Quantity
{
     get { return ComplexLogicConvertedToMethod(); }
     set { this.quantity = value ; }
}
//error CS0592: Attribute 'DebuggerStepThrough' is not valid on this declaration type.
//It is valid on 'class, struct, constructor, method' declarations only.

Instead, you need to apply it to the get/set accessors directly:

public int Quantity

    [DebuggerStepThrough] 
    get { return ComplexLogicConvertedToMethod(); } 
    [DebuggerStepThrough]      
    set { this.quantity = value ; }
}