CA1043:必須針對索引子使用整數或字串引數

  • 發行項
屬性 值
規則識別碼 CA1043
標題 必須針對索引子使用整數或字串引數
類別 設計
修正程式是中斷或非中斷 中斷
預設在 .NET 8 中啟用 No

原因

型別包含索引子，其使用 、 System.Int64 、 System.Object 或 System.String 以外的 System.Int32 索引型別。

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

檔案描述

索引子，也就是索引屬性，應該使用索引的整數或字串類型。 這些類型通常用於編制資料結構的索引，並增加程式庫的可用性。 Object使用型別應限制為無法在設計階段指定特定整數或字串類型的案例。 如果設計需要索引的其他類型，請重新考慮類型是否代表邏輯資料存放區。 如果它不代表邏輯資料存放區，請使用 方法。

如何修正違規

若要修正此規則的違規，請將索引變更為整數或字串類型，或使用 方法，而不是索引子。

隱藏警告的時機

只能在仔細考慮非標準索引子的需求之後，隱藏此規則的警告。

隱藏警告

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

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

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

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

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

設定程式碼以分析

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

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

包含特定 API 介面

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

範例

下列範例顯示使用索引的 Int32 索引子。

string[] Month = new string[] { "Jan", "Feb", "..." };

public string this[int index]
{
    get => Month[index];
}

Private month() As String = {"Jan", "Feb", "..."}

Default ReadOnly Property Item(index As Integer) As String
    Get
        Return month(index)
    End Get
End Property