Contract.Requires 方法

定义

命名空间:

System.Diagnostics.Contracts

程序集:

System.Diagnostics.Contracts.dll

为封闭方法或属性指定一个前置条件协定。

重载

Requires(Boolean)	为封闭方法或属性指定一个前置条件协定。
Requires(Boolean, String)	为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时显示一条消息。
Requires<TException>(Boolean)	为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时引发异常。
Requires<TException>(Boolean, String)	为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时引发包含提供的消息的异常。

Requires(Boolean)

Source:

Contracts.cs

为封闭方法或属性指定一个前置条件协定。

public:
 static void Requires(bool condition);

[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public static void Requires (bool condition);

[<System.Diagnostics.Conditional("CONTRACTS_FULL")>]
static member Requires : bool -> unit

Public Shared Sub Requires (condition As Boolean)

参数

condition

Boolean

要测试的条件表达式。

属性

ConditionalAttribute

注解

• 此方法调用必须在方法或属性的开头，然后再调用任何其他代码。

• 此合同向客户端公开：因此，它必须仅引用至少与封闭方法一样可见的成员。

• 当向后兼容性不强制引发特定异常时，请使用此方法而不是 Contract.Requires<TException>(Boolean) 方法。

Requires(Boolean, String)

Source:

Contracts.cs

为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时显示一条消息。

public:
 static void Requires(bool condition, System::String ^ userMessage);

[System.Diagnostics.Conditional("CONTRACTS_FULL")]
public static void Requires (bool condition, string? userMessage);

[<System.Diagnostics.Conditional("CONTRACTS_FULL")>]
static member Requires : bool * string -> unit

Public Shared Sub Requires (condition As Boolean, userMessage As String)

参数

condition

Boolean

要测试的条件表达式。

userMessage

String

条件为 false 时要显示的消息。

属性

ConditionalAttribute

注解

• 此方法调用必须在方法或属性的开头，然后再调用任何其他代码。

• 此合同向客户端公开：因此，它必须仅引用至少与封闭方法一样可见的成员。

• 当向后兼容性不强制引发特定异常时，请使用此方法而不是 Contract.Requires<TException>(Boolean, String) 方法。

Requires<TException>(Boolean)

Source:

Contracts.cs

为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时引发异常。

public:
generic <typename TException>
 where TException : Exception static void Requires(bool condition);

public static void Requires<TException> (bool condition) where TException : Exception;

static member Requires : bool -> unit (requires 'Exception :> Exception)

Public Shared Sub Requires(Of TException As Exception) (condition As Boolean)

类型参数

TException

条件为 false 时要引发的异常。

参数

condition

Boolean

要测试的条件表达式。

注解

重要

必须启用运行时检查才能使用 Requires 方法。 如果运行时检查已关闭，则进程将终止。 若要获取用于运行时检查的工具，请参阅 Visual Studio 市场中 的代码协定 。

• 此方法调用必须在方法或属性的开头，然后再调用任何其他代码。

• 此合同向客户端公开：因此，它必须仅引用至少与封闭方法一样可见的成员。

• 如果要在前提条件失败时引发异常， Contract.Requires(Boolean) 请使用此方法而不是 方法。

Requires<TException>(Boolean, String)

Source:

Contracts.cs

为封闭方法或属性指定一个前置条件协定，并在该协定的条件失败时引发包含提供的消息的异常。

public:
generic <typename TException>
 where TException : Exception static void Requires(bool condition, System::String ^ userMessage);

public static void Requires<TException> (bool condition, string? userMessage) where TException : Exception;

static member Requires : bool * string -> unit (requires 'Exception :> Exception)

Public Shared Sub Requires(Of TException As Exception) (condition As Boolean, userMessage As String)

类型参数

TException

条件为 false 时要引发的异常。

参数

condition

Boolean

要测试的条件表达式。

userMessage

String

条件为 false 时要显示的消息。

注解

• 重要

  必须启用运行时检查才能使用 Requires 方法。 如果运行时检查已关闭，则进程将终止。 若要获取用于运行时检查的工具，请参阅 Visual Studio 市场中 的代码协定 。

  此方法调用必须在方法或属性的开头，然后再调用任何其他代码。

• 此合同向客户端公开：因此，它必须仅引用至少与封闭方法一样可见的成员。

• 如果要在前提条件失败时引发异常， Contract.Requires(Boolean, String) 请使用此方法而不是 方法。