CA1040:避免使用空的介面

原因

介面不會宣告任何成員或實作兩個或多個其他介面。

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

介面是用來定義一組可提供行為或程式使用合約的成員。不論類型出現在繼承階層架構 (Inheritance Hierarchy) 中的何處，任何類型都可以採用介面所描述的功能。類型會實作介面，方法是提供介面成員的實作。空的介面不會定義任何成員。因此，它不會定義可實作的合約。

如果您的設計包含預期要實作類型的空白介面，您可能會使用介面做為標記或識別類型群組的方式。如果在運行時間發生此識別，完成此作業的正確方式就是使用自定義屬性。使用屬性是否存在或不存在屬性，或屬性的屬性來識別目標類型。如果必須在編譯階段進行識別，則可以接受使用空的介面。

拿掉介面或將成員新增至該介面。如果使用空的介面來標記一組類型，請將介面取代為自定義屬性。

當介面用來在編譯時期識別一組類型時，隱藏此規則的警告是安全的。

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

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

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

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

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

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

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

下列範例顯示空的介面。

// Violates rule
public interface IBadInterface
{
}

' Violates rule
Public Interface IBadInterface
End Interface