CA1702: Bei zusammengesetzten Begriffen sollte die Groß-/Kleinschreibung beachtet werden
TypeName |
CompoundWordsShouldBeCasedCorrectly |
CheckId |
CA1702 |
Kategorie |
Microsoft.Naming |
Unterbrechende Änderung |
Unterbrechend – Wenn für Assemblys ausgelöst. Nicht unterbrechend – Wenn für Typparameter ausgelöst. |
Ursache
Der Name eines Bezeichners enthält mehrere Begriffe, und mindestens einer der Begriffe ist anscheinend ein zusammengesetztes Wort mit falscher Groß-/Kleinschreibung.
Regelbeschreibung
Der Name des Bezeichners wird basierend auf der Groß-/Kleinschreibung in Wörter unterteilt. Jede zusammenhängende Kombination aus zwei Wörtern wird durch die Rechtschreibprüfung aus der Microsoft-Bibliothek überprüft. Falls der Bezeichner erkannt wird, erzeugt er einen Regelverstoß. Beispiele für zusammengesetzte Wörter, die eine Verletzung verursachen, sind "CheckSum" und "MultiPart", die die Schreibung "Checksum" bzw. "Multipart" aufweisen sollten. Aufgrund typischer Verwendungsweisen in der Vergangenheit wurden mehrere Einzelwörtern in die Regel integriert, sodass einige Begriffe, wie "Toolbar" und "Filename", gekennzeichnet werden. Diese Begriffe sollten als zwei getrennte Wörter erkennbar sein, in diesem Fall "ToolBar" und "FileName".
Durch Benennungskonventionen erhalten Bibliotheken, die auf die Common Language Runtime abzielen, ein einheitliches Erscheinungsbild. Dadurch wird der Lernaufwand für neue Softwarebibliotheken verringert. Zudem wird das Kundenvertrauen dahingehend gestärkt, dass die Bibliothek von einem erfahrenen Entwickler für verwalteten Code erstellt wurde.
Behandeln von Verstößen
Ändern Sie den Namen, sodass er die ordnungsgemäße Groß-/Kleinschreibung aufweist.
Wann sollten Warnungen unterdrückt werden?
Eine Warnung dieser Regel kann gefahrlos unterdrückt werden, wenn beide Teile des zusammengesetzten Begriffs vom Rechtschreibwörterbuch ordnungsgemäß erkannt werden und ausdrücklich zwei Wörter verwendet werden sollen.
Verwandte Regeln
CA1709: Bei Bezeichnern sollte die Groß-/Kleinschreibung beachtet werden
CA1708: Bezeichner sollten sich nicht nur durch die Groß-/Kleinschreibung unterscheiden
Siehe auch
Konzepte
Konventionen für die Groß-/Kleinschreibung