CA1725:參數名稱應該符合基底類型的宣告

  • 發行項
屬性 值
規則識別碼 CA1725
標題 參數名稱應該符合基底類型的宣告
類別 命名
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

方法覆寫中參數的名稱與方法基底宣告中的參數名稱或方法介面宣告中的參數名稱不符。

根據預設，此規則只會查看外部可見的方法，但這是可設定 的 。

檔案描述

在覆寫階層架構中一致的參數命名方式，會增加方法覆寫的可用性。 與基底宣告中的名稱不同之衍生方法中的參數名稱，可能會造成方法為基底方法的覆寫或為方法的新多載而混淆。

如何修正違規

若要修正此規則的違規，請重新命名 參數以符合基底宣告。 修正是 COM 可見方法的重大變更。

隱藏警告的時機

除了先前隨附的程式庫中的 COM 可見方法以外，請勿隱藏此規則的警告。

隱藏警告

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

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

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

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

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

設定程式碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal