CA1701: Wyrazy złożone ciągu zasobu należy zapisywać z uwzględnieniem wielkości liter
TypeName |
ResourceStringCompoundWordsShouldBeCasedCorrectly |
CheckId |
CA1701 |
Kategoria |
Microsoft.Naming |
Zmiana kluczowa |
Niekluczowa |
Przyczyna
Ciąg zasobu zawiera złożone słowo, w którym wielkość liter jest prawdopodobnie nieprawidłowa.
Opis reguły
Każde słowo w ciągu zasobu jest podzielone na tokeny, które są oparte na wielkości liter.Każda ciągła kombinacja dwóch tokenów jest sprawdzana przez bibliotekę sprawdzania pisowni firmy Microsoft.Jeżeli zostanie rozpoznane, słowo powoduje naruszenie reguły.Przykłady słów złożonych, które powodują naruszenie, to "CheckSum" i "MultiPart", które powinny być zapisane odpowiednio jako "Checksum" i "Multipart".W związku z występowaniem w powszechnym użyciu, wbudowano kilka wyjątków od reguły i oznaczono flagą kilka pojedynczych słów, takich jak "Toolbar" i "Filename", które powinny być zapisane jako dwa różne słowa.W tym przykładzie, "ToolBar" i "FileName" zostaną oznaczone flagą.
Konwencje nazewnictwa zapewniają wspólny wygląd bibliotek przeznaczonych docelowo dla środowiska uruchomieniowego CLR.Zmniejsza to krzywą zdobywania wiedzy, która jest wymagana dla nowych bibliotek oprogramowania i zwiększa ufność klientów w to, że biblioteka został opracowana przez osobę, która ma doświadczenie w rozwijaniu kodu zarządzanego.
Jak naprawić naruszenia
Zmień słowo, tak aby wielkość liter była w nim prawidłowa.
Kiedy pominąć ostrzeżenia
Można bezpiecznie pominąć ostrzeżenie dotyczące tej reguły, jeżeli obie części złożonego słowa są rozpoznawane przez słownik sprawdzania pisowni i zamiarem jest użycie dwóch słów.
Złożone słowa możesz również dodać do niestandardowego słownika sprawdzania pisowni.Słowa ze słownika niestandardowego nie powodują naruszeń.Aby uzyskać więcej informacji, zobacz Porady: dostosowywanie słownika analizy kodu.
Powiązane reguły
CA1702: Wyrazy złożone należy zapisywać z uwzględnieniem wielkości liter
CA1709: Identyfikatory powinny być zapisywane z uwzględnieniem wielkości liter
CA1708: Identyfikatory powinny różnić się czymś więcej niż wielkością liter