CA1508:避免使用無作用條件式程式碼

文章
02/21/2024

屬性	值
規則識別碼	CA1508
標題	避免使用無作用條件式程式碼
類別	可維護性
修正程式是中斷或非中斷	非中斷
預設在 .NET 8 中啟用	No

原因

方法具有條件碼，該條件碼一律會在執行階段評估為 true 或 false。這會導致條件 false 分支中的無作用程式碼。

根據預設，此規則會分析整個程式代碼基底，但這是可設定的。

檔案描述

方法可以有條件式程序代碼，例如 if 語句、二進位運算式（==、、、!=<）、>Null 檢查等。例如，請考慮下列程式代碼：

public void M(int i, int j)
{
    if (i != 0)
    {
        return;
    }

    if (j != 0)
    {
        return;
    }

    // Below condition will always evaluate to 'false' as 'i' and 'j' are both '0' here.
    if (i != j)
    {
        // Code in this 'if' branch is dead code.
        // It can either be removed or refactored.
        ...
    }
}

C# 和 VB 編譯程式會執行條件式檢查的分析，其中包含一律評估為或的編譯時間常數值。falsetrue 此分析器會執行非常數變數的數據流分析，以判斷涉及非常數值的備援條件式檢查。在上述程式代碼中，分析器會判斷和 ij 都是 0 針對所有到達 i != j 檢查的程式代碼路徑。因此，此檢查一律會在執行時間評估為 false 。 if 語句內的程式代碼是無效的程序代碼，而且可以移除或重構。同樣地，分析器會追蹤變數的 Null 性，並報告多餘的 Null 檢查。

注意

此分析器會執行非常數值的昂貴數據流分析。這可能會在特定程式代碼基底上增加整體編譯時間。

隱藏警告的時機

如果您不擔心程式代碼的可維護性，則隱藏此規則的違規是安全的。您也可以隱藏識別為誤判的違規行為。這些可能存在於可從多個線程執行的並行程式代碼中。

隱藏警告

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

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

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

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

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

設定程式代碼以分析

使用下列選項來設定程式代碼基底要執行此規則的部分。

排除特定符號
排除特定類型及其衍生類型

您可以只針對此規則、它套用的所有規則，或針對套用至此類別的所有規則設定這些選項（可維護性）。如需詳細資訊，請參閱程式代碼品質規則組態選項。

排除特定符號

您可以從分析中排除特定符號，例如類型和方法。例如，若要指定規則不應該在名為 MyType的任何程式代碼上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType

選項值中允許的符號名稱格式（以 |分隔）：

只包含符號名稱（包含名稱的所有符號，不論包含類型或命名空間為何）。
符號檔案識別碼格式的完整名稱。每個符號名稱都需要符號種類前置詞，例如 M: 方法、 T: 類型和 N: 命名空間。
.ctor 用於建構函式和 .cctor 靜態建構函式。

範例：

選項值	摘要
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType`	符合所有名為 `MyType`的符號。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = MyType1\|MyType2`	比對名為 `MyType1` 或 `MyType2`的所有符號。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS.MyType.MyMethod(ParamType)`	比對特定方法 `MyMethod` 與指定的完整簽章。
`dotnet_code_quality.CAXXXX.excluded_symbol_names = M:NS1.MyType1.MyMethod1(ParamType)\|M:NS2.MyType2.MyMethod2(ParamType)`	比對特定方法和`MyMethod1MyMethod2`個別的完整簽章。

排除特定類型及其衍生類型

您可以從分析中排除特定類型及其衍生類型。例如，若要指定規則不應該在具名 MyType 類型及其衍生型別內的任何方法上執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.excluded_type_names_with_derived_types = MyType