Posts mit dem Label StyleCop werden angezeigt. Alle Posts anzeigen
Posts mit dem Label StyleCop werden angezeigt. Alle Posts anzeigen

Freitag, 29. August 2008

Microsoft StyleCop 4.3 SDK Dokumentation veröffentlicht

Wie ich gerade via Microsoft StyleCop Blog erfahren habe, wurde soeben die Dokumentation des StyleCop 4.3 SDK veröffentlicht. Zu beziehen ist diese hier.

Noch habe ich nicht in die heruntergeladene CHM-Datei geschaut, doch wird versprochen, dass erläutert wird, wie eigene StyleCop-Regeln erstellt und verwendet werden können, wie man dem Settings-Dialog des StyleCop eigene Settings hinzufügen kann und wie man den StyleCop in seine vorhandene Build-Umgebung einbetten kann.

Der erste Punkt ist dabei der, der mich am meisten freut, denn bei uns in der Firma ist es vorgeschrieben, dass auf deutsch dokumentiert wird. Da bringen mir die Regeln des StyleCop nicht wirklich viel, die mir sagen, dass ein Dokumentationskommentar für Konstruktoren gefälligst mit "Initializes a new instance of the XYZ class" anzufangen haben. Also geht es jetzt mit munterem lokalisieren und Rule-Bobbeln los. Das Wochenende ist gerettet!

Mittwoch, 20. August 2008

StyleCop v4.3 erschienen

Wie ich gerade anhand des Microsoft StyleCop-Blogs erfahren habe, ist die neue Version 4.3 des StyleCop erschienen.

Unter anderem wurden in dieser Version einige Bugs gefixt sowie neue Rules eingefügt. Sehr schön finde ich auch, dass die Definition der einzelnen Rules jetzt wohl im Visual Studio verfübar sein soll. Bis jetzt musste ich immer das WWW durchforsten, wenn ich eine mir unbekannte Rule-Verletzung im Code hatte. Sehr positive Entwicklung.

Zum Download geht es hier. Unter diesem Link steht auch eine Doku zur Verfügung, die ebenfalls die Rules und deren Erklärung enthält.

Montag, 18. August 2008

Microsoft StyleCop

Vor kurzem bin ich wieder einmal über ein sehr nettes Tool gestolpert, das Microsoft den C#-Programmierern zur Verfügung stellt, um die Codequalität zu verbessern, ähnlich dem FxCop. Anders als der angesprochene FxCop analysiert der StyleCop allerdings keine Assemblies sondern den geschriebenen Code direkt im VisualStudio. Auch werden von ihm natürlich andere Themengebiete abgedeckt als vom FxCop.

Hat man den StyleCop hier heruntergeladen und installiert, hat man im VisualStudio im Menü "Extras" ("Tools" in der englischen Version) zwei neue Menüpunkte, mämlich "Run Source Analysis" und "Run Source Analysis (Rescan all)". Die erste Option kann auch durch die Tastenkombination Ctrl + Shift + Y aufgerufen werden. Führt man die Quellcode-Analyse durch, erscheint ein neues Fenster, das die Ergebnise für die Solution enthält.

Hingewiesen wird hier unter anderem auf fehlende Dokumentationskommentare, "falsche" Formatierung und ähnliches. Weiterhin bekommt man eine Meldung, wenn man beispielsweise vergessen hat, einer Klasse explizit einen Zugriffsmodifizierer zuzuweisen, was ja doch schon mal passieren kann, wenn die Klasse sowieso private sein soll.

Interessant finde ich das AddOn hauptsächlich deswegen, weil es einem die Coding-Guidelines, die (zumindest teilweise) bei Microsoft verwendet werden. Ein paar Kleinigkeiten habe ich bereits gelernt, zum Beispiel, dass Using-Direktiven innerhalb eines Namespace gemacht werden und jede Datei einen definierten Header bekommen sollte. Die Sache mit den Using-Direktiven verstehe ich zwar noch nicht wirklich, doch den Grund hierfür werde ich schon noch herausfinden.  Falls da jemand etwas Genaueres sagen kann, so möge er dies doch bitte via Kommentar tun. Header verwende ich natürlich in meinen Sourcefiles, doch nicht in der Form, wie sie der StyleCop verlangt.

Für jeden, der sich für die Optimierung seines Codings interessiert, der möge sich den StyleCop herunterladen und installieren. Bei mir wird er jedenfalls jetzt regelmäßig zum Einsatz kommen.

Nachtrag: Wie ich gerade festgestellt habe, halten sich die von VisualStudio generierten Codedateien selbst nicht an die Vorgabe des StyleCop. Interessant...