CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | CA1708 |
| Stanowisko | Identyfikatory powinny różnić się nie tylko wielkością liter |
| Kategoria | Nazewnictwo |
| Poprawka powodująca niezgodność lub niezgodność | Kluczowa |
| Domyślnie włączone na platformie .NET 8 | Nie. |
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 parametry nie mogą się różnić jedynie wielkością liter, ponieważ języki dla środowiska uruchomieniowego języka wspólnego nie muszą rozróżniać wielkości liter. Na przykład Język Visual Basic jest powszechnie używanym językiem bez uwzględniania wielkości liter.
Jak naprawić naruszenia
Wybierz unikatową nazwę w porównaniu 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 bazy kodu mają być uruchamiane w tej regule.
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órych częściach bazy kodu ma być uruchamiana ta reguła, na podstawie ich ułatwień dostępu. 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
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;
}
