ConditionalAttribute 类

定义

命名空间:

System.Diagnostics

程序集:

System.Runtime.dll

Source:

ConditionalAttribute.cs

指示编译器，除非定义了指定的有条件编译符号，否则，应忽略方法调用或属性。

public ref class ConditionalAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
public sealed class ConditionalAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)>]
type ConditionalAttribute = class
    inherit Attribute

Public NotInheritable Class ConditionalAttribute
Inherits Attribute

继承

Object

Attribute

ConditionalAttribute

属性

AttributeUsageAttribute

示例

以下示例演示了 ConditionalAttribute 的用法。 该示例假定条件是使用 /define 编译器选项定义的。 可以通过更改编译器选项来获取不同的结果。 你可以选择通过使用代码示例中的杂注而不是将这些杂注标识为编译器选项来定义条件。

#define CONDITION1
#define CONDITION2
using System;
using System.Diagnostics;

class Test
{
    static void Main()
    {
        Console.WriteLine("Calling Method1");
        Method1(3);
        Console.WriteLine("Calling Method2");
        Method2();

        Console.WriteLine("Using the Debug class");
        Debug.Listeners.Add(new ConsoleTraceListener());
        Debug.WriteLine("DEBUG is defined");
    }

    [Conditional("CONDITION1")]
    public static void Method1(int x)
    {
        Console.WriteLine("CONDITION1 is defined");
    }

    [Conditional("CONDITION1"), Conditional("CONDITION2")]
    public static void Method2()
    {
        Console.WriteLine("CONDITION1 or CONDITION2 is defined");
    }
}

/*
When compiled as shown, the application (named ConsoleApp)
produces the following output.

Calling Method1
CONDITION1 is defined
Calling Method2
CONDITION1 or CONDITION2 is defined
Using the Debug class
DEBUG is defined
*/

#Const CONDITION1 = True
#Const CONDITION2 = True
Imports System.Diagnostics

Class Test

    Shared Sub Main()
        Console.WriteLine("Calling Method1")
        Method1(3)
        Console.WriteLine("Calling Method2")
        Method2()
        
        Console.WriteLine("Using the Debug class")
        Debug.Listeners.Add(New ConsoleTraceListener())
        Debug.WriteLine("DEBUG is defined")
    End Sub
       
    <ConditionalAttribute("CONDITION1")> _
    Shared Sub Method1(x As Integer)
        Console.WriteLine("CONDITION1 is defined")
    End Sub
    
    <ConditionalAttribute("CONDITION1"), ConditionalAttribute("CONDITION2")> _
    Shared Sub Method2()
        Console.WriteLine("CONDITION1 or CONDITIOIN2 is defined")
    End Sub
    
End Class


' When compiled as shown, the application (named ConsoleApp) 
' produces the following output.

'Calling Method1
'CONDITION1 is defined
'Calling Method2
'CONDITION1 or CONDITION2 is defined
'Using the Debug class
'DEBUG is defined

注解

可以将 特性应用于 ConditionalAttribute 方法和类。 但是，它在类上的使用仅对派生自 Attribute的类型有效。 ConditionalAttribute 如果将编译器警告或错误消息应用于任何其他类型，则将忽略或生成编译器警告或错误消息。

应用于 ConditionalAttribute 方法向编译器指示对方法的调用不应编译为 Microsoft 中间语言 (MSIL) ，除非定义了与 ConditionalAttribute 关联的条件编译符号。 如果您将此特性应用于不返回 void 的方法，则将在 Visual Studio 中收到编译错误。 应用于 ConditionalAttribute 属性表示，除非定义了条件编译符号，否则不应向元数据发出该特性。 传递给方法或特性的任何参数仍由编译器进行类型检查。

可以使用以下方法定义条件编译符号：

• 使用编译器命令行选项;例如 /define：DEBUG。

• 在操作系统 shell 中使用环境变量;例如， 将 DEBUG=1 设置为 。

• 在源代码中使用杂注；例如，定义编译变量，如下所示：

  #define DEBUG  
  

  #Const DEBUG=True  
  

  若要取消定义变量，请使用下列内容：

  #undef DEBUG  
  

  #Const DEBUG=False  
  

允许符合公共语言规范 (CLS) 的编译器忽略 ConditionalAttribute。 C#、F#、Visual Basic 和 C++ 编译器支持 ConditionalAttribute;JScript 编译器不支持 特性。

注意

在 Visual Basic 中，AddressOf 运算符不受此特性的影响。 例如，Call CType(AddressOf delegate, Action) 始终调用 delegate，但 Call delegate() 不会执行此操作。

ConditionalAttribute应用于 和 Trace 类中Debug定义的方法。

有关如何使用属性的详细信息，请参阅 特性。

构造函数

ConditionalAttribute(String)

初始化 ConditionalAttribute 类的新实例。

属性

ConditionString	获取与 ConditionalAttribute 属性相关的条件编译符号。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)