CA2247:傳遞至 TaskCompletionSource 建構函式的引數應該是 TaskCreationOptions 列舉,而不是 TaskContinuationOptions 列舉

屬性
規則識別碼 CA2247
標題 傳遞到 TaskCompletionSource 建構函式的引數應為 TaskCreationOptions 列舉,而非 TaskContinuationOptions 列舉
類別 使用方式
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 作為警告

原因

使用 System.Threading.Tasks.TaskCompletionSourceSystem.Threading.Tasks.TaskContinuationOptions 列舉值建構 ,而不是 System.Threading.Tasks.TaskCreationOptions 列舉值。 使用 System.Object.ReferenceEquals 方法來測試一或多個實值型別是否相等。

檔案描述

TaskCompletionSource 類型具有接受 System.Threading.Tasks.TaskCreationOptions 列舉值的建構函式,以及接受 的另一個建 Object 構函式。 不小心傳遞 System.Threading.Tasks.TaskContinuationOptions 列舉值而非 System.Threading.Tasks.TaskCreationOptions 列舉值會導致呼叫 Object 以為基礎的建構函式:它會編譯並執行,但不會有預定的行為。

如何修正違規

若要修正違規,請將 System.Threading.Tasks.TaskContinuationOptions 列舉值取代為對應的 System.Threading.Tasks.TaskCreationOptions 列舉值。

    // Violation
    var tcs = new TaskCompletionSource<int>(TaskContinuationOptions.RunContinuationsAsynchronously);

    // Fixed
    var tcs = new TaskCompletionSource<int>(TaskCreationOptions.RunContinuationsAsynchronously);

隱藏警告的時機

違反此規則幾乎一律會反白顯示呼叫程式碼中的 Bug,因此程式碼不會如開發人員預期般運作,TaskCompletionSource 實際上會忽略指定的選項。 隱藏警告的唯一時間是,如果開發人員實際打算將 Boxed System.Threading.Tasks.TaskContinuationOptions 當做物件狀態引數傳遞給 , TaskCompletionSource

隱藏警告

如果您只想要隱藏單一違規,請將預處理器指示詞新增至原始程式檔以停用,然後重新啟用規則。

#pragma warning disable CA2247
// The code that's violating the rule is on this line.
#pragma warning restore CA2247

若要停用檔案、資料夾或專案的規則,請在組態檔 中將其嚴重性設定為 。 none

[*.{cs,vb}]
dotnet_diagnostic.CA2247.severity = none

若要停用此整個規則類別,請將組態檔中類別的嚴重性設定為 none

[*.{cs,vb}]
dotnet_analyzer_diagnostic.category-Usage.severity = none

如需詳細資訊,請參閱 如何隱藏程式碼分析警告 。。

另請參閱