CA1801:必須檢閱未使用的參數

  • 發行項
屬性 值
規則識別碼 CA1801
標題 必須檢閱未使用的參數
類別 使用方式
修正程式是中斷或非中斷 非中斷 - 如果成員在元件外部看不到，則不論您所做的變更為何。

非中斷性 - 如果您將成員變更為在其主體內使用 參數。

中斷 - 如果您移除 參數，而且它會顯示在元件外部。
預設在 .NET 8 中啟用 No

原因

方法簽章包含方法主體中未使用的參數。

此規則不會檢查下列型態的方法：

  • 委派所參考的方法。

  • 做為事件處理程式的方法。

  • 串行化建構函式（請參閱指導方針）。

  • 串行化 GetObjectData 方法。

  • 以 abstract （MustOverride 在 Visual Basic） 修飾詞中宣告的方法。

  • 以 virtual （Overridable 在 Visual Basic） 修飾詞中宣告的方法。

  • 以 override （Overrides 在 Visual Basic） 修飾詞中宣告的方法。

  • 以 extern Visual Basic 中的 語句Declare 宣告的方法。

此規則不會標幟以捨棄符號命名的參數，例如、 __1和 _2。 這可減少簽章需求所需參數的警告雜訊，例如，做為委派的方法、具有特殊屬性的參數，或架構在運行時間隱含存取值但未在程式代碼中參考的參數。

注意

這項規則已被取代，有利於 IDE0060。 如需如何在組建中強制執行IDE0060分析器的資訊，請參閱 程式代碼樣式分析。

檔案描述

檢閱方法主體中未使用之非虛擬方法中的參數，以確定存取這些參數時不存在錯誤。 未使用的參數會產生維護和效能成本。

有時候，違反此規則可能會指向方法中的實作 Bug。 例如，參數應該已在方法主體中使用。 如果參數因為回溯相容性而必須存在，則隱藏此規則的警告。

如何修正違規

若要修正違反此規則的行為，請移除未使用的參數（中斷性變更），或使用方法主體中的 參數（非中斷性變更）。

隱藏警告的時機

隱藏此規則的警告是安全的：

隱藏警告

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

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

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

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

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

設定程式代碼以分析

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

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

包含特定 API 介面

您可以根據程式代碼基底的存取範圍，設定要執行此規則的部分。 例如，若要指定規則只應該針對非公用 API 介面執行，請將下列機碼/值組新增至 專案中的 .editorconfig 檔案：

dotnet_code_quality.CAXXXX.api_surface = private, internal

根據預設，CA1801 規則會套用至所有 API 介面（公用、內部和私用）。

範例

下列範例顯示兩種方法。 其中一個方法違反規則，另一個方法滿足規則。

// This method violates the rule.
public static string GetSomething(int first, int second)
{
    return first.ToString(CultureInfo.InvariantCulture);
}

// This method satisfies the rule.
public static string GetSomethingElse(int first)
{
    return first.ToString(CultureInfo.InvariantCulture);
}