System.Diagnostics.DebuggableAttribute Class

Summary

Modifies code generation for runtime just-in-time (JIT) debugging. This class cannot be inherited.

C# Syntax:

[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Module)] public sealed class DebuggableAttribute : Attribute

The DebuggableAttribute controls how the runtime treats code within the module. The runtime might track extra information about generated code, and it might disable certain optimizations based on the values contained within this attribute.

For more information about using attributes, see the conceptual topic at MSDN: extendingmetadatausingattributes.

System.Diagnostics Namespace

System.Diagnostics.DebuggableAttribute Member List:

Public Constructors

ctor #1

Sets the conditions to control code generation for runtime just-in-time (JIT) debugging.

Public Properties

IsJITOptimizerDisabled	Read-only Gets a value that indicates whether the runtime optimizer is disabled.
IsJITTrackingEnabled	Read-only Gets a value that indicates whether the runtime will track information during code generation for the debugger.
TypeId (inherited from System.Attribute)	Read-only See base class member description: System.Attribute.TypeId When implemented in a derived class, gets a unique identifier for this Attribute.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Attribute)	See base class member description: System.Attribute.GetHashCode Returns the hash code for this instance.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
IsDefaultAttribute (inherited from System.Attribute)	See base class member description: System.Attribute.IsDefaultAttribute When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Match (inherited from System.Attribute)	See base class member description: System.Attribute.Match When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Attribute
• System.Diagnostics.DebuggableAttribute

System.Diagnostics.DebuggableAttribute Member Details

Summary

Sets the conditions to control code generation for runtime just-in-time (JIT) debugging.

C# Syntax:

public DebuggableAttribute(    bool isJITTrackingEnabled,    bool isJITOptimizerDisabled );

isJITTrackingEnabled

true to enable debugging; otherwise, false.

isJITOptimizerDisabled

true to disable the optimizer for execution; otherwise, false.

Sets the properties DebuggableAttribute.IsJITTrackingEnabled and DebuggableAttribute.IsJITOptimizerDisabled.

A isJITTrackingEnabaled value of true causes the runtime to track information important to the debugger during code generation; a value of false results in no tracking, but does not prevent debugging.

A isJITOptimizerDisabled value of true optimizes for debugging, a value of false optimizes for execution.

Return to top

Summary

Gets a value that indicates whether the runtime optimizer is disabled.

C# Syntax:

public bool IsJITOptimizerDisabled {get;}

A value of true enhances performance for runtime debugging, which can cause a decline in execution performance. A value of false enhances performance for execution. When DebuggableAttribute.IsJITOptimizerDisabled is set to false, stepping through code might result in a different behavior then when set to true because the compilier might reorder instructions or insert jumps to common code.

Return to top

Summary

Gets a value that indicates whether the runtime will track information during code generation for the debugger.

C# Syntax:

public bool IsJITTrackingEnabled {get;}

DebuggableAttribute.IsJITTrackingEnabled controls whether the runtime tracks information important to the debugger during code generation. This information helps the debugger provide a rich debugging experience.

Note This property does not control the ability to debug, but tells the just-in-time (JIT) compiler to generate tracking info. Specifically, the Microsoft Intermediate Language (MSIL)-offset to the native-code offset within a method.

Return to top

Inherited
See base class member description: System.Attribute.TypeId

Summary

When implemented in a derived class, gets a unique identifier for this Attribute.

C# Syntax:

public virtual object TypeId {get;}

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top

Inherited
See base class member description: System.Object.Equals

C# Syntax:

public virtual bool Equals(    object obj );

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~DebuggableAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.GetHashCode

Summary

Returns the hash code for this instance.

C# Syntax:

public override int GetHashCode();

Return Value:

A 32-bit signed integer hash code.

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary

When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.

C# Syntax:

public virtual bool IsDefaultAttribute();

Return Value:

true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top

Inherited
See base class member description: System.Attribute.Match

Summary

When overridden in a derived class, returns a value indicating whether this instance equals a specified object.

C# Syntax:

public virtual bool Match(    object obj );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.ToString

C# Syntax:

public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top

Top of page