Style Cop in Visual Studio einsetzen

Nachdem ich im Juli aufgrund von Urlaub und Projekteinsatz nichts gepostet habe, versuche ich es diesmal gleich mit etwas Neuem. Statt eines Blogposts habe ich ein Video aufgenommen. In diesem zeige ich wie man Style Cop in das Visual Studio einbinden kann, worum es sich bei dem Tool handelt und wie man die hinterlegten Regeln anpassen kann.

Der Regelsatz den wir verwenden kann hier herunter geladen werden: Angepasste Style Cop Settings

Folgende Regeln sind darin deaktiviert. Die Begründung ist dabei teils subjektiv, stellt aber die übereinstimmende Meinung unserer Teammitglieder dar. In anderen Teams, kann man auch zu anderen Ansichten kommen.

Rule Name Begründung
1602 EnumerationItemsMustBeDocumented Namen sollten generell selbstbeschreibend sein. Dies ist in einem Code Review zu prüfen. Zusätzliche Kommentare stellen daher häufig nur das Offensichtliche fest.
1609 PropertyDocumentationMustHaveValue Bietet keinen zusätzlichen Vorteil, da die Property ohnehin dokumentiert sein muss.
1610 PropertyDocumentationMustHaveValueText Bietet keinen zusätzlichen Vorteil, da die Property ohnehin dokumentiert sein muss.
1628 DocumentationTextMustBeginnWithACapitalLetter Bietet keinen zusätzlichen Vorteil, kann aber sehr störend sein.
1629 DocumentationTextMustEndWithAPeriod Bietet keinen zusätzlichen Vorteil, kann aber sehr störend sein.
1632 DocumentationTextMustMeetMinimumCharacterLength Das ein Inhalt bei der Dokumentation vorliegt wird durch andere Regeln schon geprüft. In den Sonderfällen kann es aber stören.
1633 bis 1649 FileHeader… Alle Elemente in der Datei müssen dokumentiert sein. Diese Regel führt häufig zu doppelten Beschreibungen. Sollte angepasst werden wenn ein Copyright o.ä. in die Dateien einzufügen ist.
1501 StatementMustNotBeOnSingleLine Kein Vorteil, es kann aber zu unübersichtlich langen Dateien kommen.
1504 AllAccessorsMustBeMultiLineOrSingleLine Kein Vorteil, es kann aber zu unübersichtlich langen Dateien kommen.
1305 FieldNamesMustNotUseHungarianNotation Fachbegriffe und Abkürzungen führen zu sehr vielen falschen Warnungen.
1200 UsingDirectivesMustBePlacedWithinNamespace Die Regel soll Fehler verhindern die durch Namensräume entstehen welche genauso heißen wie Klassen, dies ist generell zu vermeiden und über ein Code Review zu prüfen.
1123, 1124 Regions Die Nutzung von Regions ist sehr umstritten, da sie selbst zu mehr Klicks in der IDE führen und unter Umständen die Zusammenhänge von Code verschleiern können. Sie können zwar verwendet werden, ihre Verwendung wird aber nicht erzwungen.