Das Tool hat nämlich leider das Problem, dass z.B. Fantasienamen wie "Krytpa" als nicht bekannt gelten (klar, woher auch?) und entsprechend als änderungsbedürftig angezeigt werden.
Dem kann allerdings über ein eigenes Wörterbuch für das Tool leicht Abhilfe geschaffen werden.
Wörterbuch anlegen
Um ein eigenes Wörterbuch anzulegen, muss lediglich eine XML-Datei zum Projekt hinzugefügt werden, welches mit StyleCop analysiert wird.
Diese kann man beliebig benennen, "CustomDictionary.xml" bietet sich allerdings an.
Füllt man diese Datei nun mit folgendem Inhalt, kennt StyleCop plötzlich alle angegebenen Wörter und meldet diese nicht mehr als fehlerhaft. Hier ist natürlich zu beachten, dass nur Wörter ausgeblendet werden, die wirklich nicht fehlerhaft sind, nicht solche, die von StyleCop aus gutem Grund als unbekannt gemeldet werden (auch auf Buchstabendreher achten!).
<?xml version="1.0" encoding="utf-8" ?>Hierbei handelt es sich natürlich nicht um den vollständigen Funktionsumfang der eigenen Wörterbücher - deshalb heißt die Rubrik ja auch "Quick'n'Dirty" - sondern nur um einen kleinen (!) Ausschnitt. Im Laufe der Zeit werde ich versuchen, noch mehr solcher nützlichen Methoden aufzuzeigen.
<Dictionary>
<Words>
<Recognized>
<Word>Fantasiewort 1</Word>
<Word>Fantasiewort 2</Word>
</Recognized>
</Words>
</Dictionary>
Dictionary einbinden
Zunächst stellte sich bei mir Frustration ein, denn das eigene Wörterbuch wurde vollständig ignoriert!
Ich ärgerte mich bereits, erinnerte mich aber schnell daran, dass solche und ähnliche Probleme oftmals über die Build Action einer Datei (Eigenschaften der Datei aufrufen) gelöst werden können.
Und tatsächlich: Unter Build Action fand sich der Eintrag "Code Analysis Dictionary"! Kaum hatte ich diese Eigenschaft gesetzt, wurden die von mir eingetragenen Wörter als nicht fehlerhaft erkannt und entsprechend auch nicht mehr gemeldet.
Bevor die Eintragungen wirksam werden, ist bei mir ein Rebuild der betroffenen Assembly notwendig!
No comments:
Post a Comment