Udostępnij za pośrednictwem


CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter

Właściwości Wartość
Identyfikator reguły CA1708
Tytuł Identyfikatory powinny różnić się nie tylko wielkością liter
Kategoria Nazewnictwo
Poprawka łamiąca lub nienaruszająca Przełomowe
Domyślnie włączone na platformie .NET 10 Nie.
Zastosowane języki C# i Visual Basic

Przyczyna

Nazwy dwóch typów, składowych, parametrów lub w pełni kwalifikowanych przestrzeni nazw są identyczne, gdy są konwertowane na małe litery.

Domyślnie ta reguła analizuje tylko typy widoczne zewnętrznie, elementy członkowskie i przestrzenie nazw, ale jest to możliwe do skonfigurowania.

Opis reguły

Identyfikatory przestrzeni nazw, typów, elementów członkowskich i parametrów nie mogą różnić się jedynie wielkością liter, ponieważ języki, które działają na środowisku uruchomieniowym języka wspólnego, nie muszą rozróżniać wielkości liter. Na przykład Visual Basic jest powszechnie używanym językiem niewrażliwym na wielkość liter.

Jak naprawić naruszenia

Wybierz unikatową nazwę, gdy będzie porównywana z innymi identyfikatorami w sposób niewrażliwy na wielkość liter.

Kiedy pomijać ostrzeżenia

Nie pomijaj ostrzeżeń dla tej reguły. Biblioteka może nie być dostępna we wszystkich dostępnych językach na platformie .NET.

Konfigurowanie kodu do analizowania

Użyj następującej opcji, aby skonfigurować, które części kodu mają być objęte tą regułą.

Tę opcję można skonfigurować tylko dla tej reguły, dla wszystkich reguł, do których ma ona zastosowanie, lub dla wszystkich reguł w tej kategorii (nazewnictwo), których dotyczy. Aby uzyskać więcej informacji, zobacz Opcje konfiguracji reguły jakości kodu.

Uwzględnij określone powierzchnie interfejsu API

Możesz skonfigurować, na które części bazy kodu ma być stosowana ta reguła, na podstawie ich poziomu dostępu, ustawiając opcję api_surface. Aby na przykład określić, że reguła powinna być uruchamiana tylko na powierzchni niepublicznego interfejsu API, dodaj następującą parę klucz-wartość do pliku editorconfig w projekcie:

dotnet_code_quality.CAXXXX.api_surface = private, internal

Notatka

Zastąp część XXXXCAXXXX identyfikatorem odpowiedniej reguły.

Przykład naruszenia

W poniższym przykładzie pokazano naruszenie tej reguły.

public class Class1
{
    protected string someName;
    public string SomeName => someName;
}

Poniższy przykład przedstawia jeden ze sposobów naprawienia naruszenia

public class Class1
{
    protected string _someName;
    public string SomeName => _someName;
}