Posts
337
Comments
125
Trackbacks
5
Wednesday, February 18, 2009
Tools für einen besseren Quellcode I

Von Microsoft gibt es das kostenlose Tool StyleCop (Version 4.3), downloadbar unter: http://code.msdn.microsoft.com/sourceanalysis/Release/ProjectReleases.aspx?ReleaseId=1425.

StyleCop vergleicht den C#-Quellcode (VB.NET wird nicht unterstützt) mit den von Microsoft empfohlenen .NET Framework Design Guidelines. Der Sinn dahinter ist es nicht nur das ein robusterer Code entsteht, sondern - wenn sich möglich viele daran halten - der erstellte Quellcode für jeden Dritten leichter zu verstehen und zu erweitern ist, da er nach allgemeinen gültigen Regeln (Benamung etc) erstellt wurde.

Dieses Programm ist ein AddOn für Visual Studio und lässt sich nach der Installation über das Menü Extra sowie über das Kontextmenü aufrufen:

StyleCop1


Nachdem StyleCop den Quellcode analysiert hat gibt er seine Warnungen und Vorschläge in der Fehlerliste im Tab Warnungen aus. Darunter fallen Hinweise wie fehlende Dokumentation, "falsche" Formatierung, fehlende Zugriffsmodifizierer, etc.

StyleCop2


Die zu berücksichtigenden Regeln lassen sich mit dem ebenfalls installierten Programm (Settings) festlegen:

StyleCop3

So z.B. ob wirklich jedes Element mit einer Summary dokumentiert werden muss (meist reicht ja ein sprechender Name aus), ob Tabs zum einrücken verwendet werden dürfen oder nur Leerzeichen etc. Die zu berücksichtigenden Regeln variieren wahrscheinlich von Projekt zu Projekt.


Links:
http://code.msdn.microsoft.com/sourceanalysis/Release/ProjectReleases.aspx?ReleaseId=1425
http://blogs.msdn.com/sourceanalysis/
http://www.onedotnetway.com/stylecop-tutorial/

posted @ Wednesday, February 18, 2009 4:27 PM | Feedback (0)