Contract.Requires 方法

定義

命名空間:

System.Diagnostics.Contracts

組件:

System.Diagnostics.Contracts.dll

指定封入方法或屬性的前置條件合約。

多載

Requires(Boolean)	指定封入方法或屬性的前置條件合約。
Requires(Boolean, String)	指定封入方法或屬性的前置條件合約，並在合約的條件失敗時顯示訊息。
Requires<TException>(Boolean)	指定封入方法或屬性的前置條件合約，並在合約的條件失敗時擲回例外狀況。
Requires<TException>(Boolean, String)	指定封入方法或屬性的前置條件合約，並在合約的條件失敗時擲回包含所提供訊息的例外狀況。

Requires(Boolean)

來源:

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)

來源:

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)

來源:

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 Marketplace 上的程式 碼合約 。

• 這個方法呼叫必須在方法或屬性的開頭，才能進行任何其他程序代碼。

• 此合約會公開給用戶端;因此，它只能參考至少與封入方法一樣可見的成員。

• 如果您想要在前置條件失敗時擲回例外狀況，請使用這個方法，而不是 Contract.Requires(Boolean) 方法。

Requires<TException>(Boolean, String)

來源:

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 Marketplace 上的程式 碼合約 。

  這個方法呼叫必須在方法或屬性的開頭，才能進行任何其他程序代碼。

• 此合約會公開給用戶端;因此，它只能參考至少與封入方法一樣可見的成員。

• 如果您想要在前置條件失敗時擲回例外狀況，請使用這個方法，而不是 Contract.Requires(Boolean, String) 方法。