CA2012：必須正確使用 ValueTasks

  • 發行項
屬性 值
規則識別碼 CA2012
標題 必須正確使用 ValueTasks
類別 可靠性
修正程式是中斷或非中斷 不中斷
預設在 .NET 8 中啟用 建議

原因

ValueTask從成員調用傳回的實例會以可能導致例外狀況、損毀或效能不佳的方式使用。

檔案描述

ValueTask 從成員調用傳回的實例是要直接等候。 嘗試多次取用 ValueTask，或在已知完成之前直接存取某個結果，可能會導致例外狀況或損毀。 忽略這類 ValueTask 可能是功能錯誤 (bug) 的指示，而且可能會導致效能降低。

如何修正違規

一般而言，ValueTasks 應該直接等候，而不是捨棄或儲存到其他位置，例如區域變數或欄位。

隱藏警告的時機

對於 ValueTask 從任意成員呼叫傳回的物件，呼叫端必須假設 ValueTask 必須取用 一次，而且只能取用一次。 不過，如果開發人員也控制所叫用的成員，並且完全瞭解其實作，開發人員可能會知道隱藏警告是安全的，例如，如果傳回 ValueTask 一律會包裝 Task 物件。

隱藏警告

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

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

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

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

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

另請參閱