Nur 1,29 Fehler pro Zeile…

…aber wenn wir mal ehrlich sind, dann sind es eigentlich ja nichtmal Fehler, sondern nur „Warnungen“. Wovon ich rede? Derzeit bin ich bemüht, meine Arbeitsweise und die meiner Kollegen besser zu strukturieren. Der erste Anhaltspunkt ist dabei natürlich, dass alle die gleiche „Sprache“ sprechen, und sich an einen gemeinsamen Stil gewöhnen und halten. Ohne eine derartige Vorgabe haben Programmierer nämlich die Eigenschaft, sich ihren eigenen Stil anzugewöhnen, der, ähnlich wie eine Handschrift, für jeden Programmierer fast einzigartig ist. Und jeder der schon einmal versucht hat, anderer Leute Handschrift zu kopieren, und dabei nicht grade ein Künstler ist, der in einem Animationsstudio arbeiten könnte, weiß wie schwer es sein kann, die richtigen Nuancen zutreffen. Und so ist es auch bei Programmierern. Bis sich ein Programmierer in die Handschrift eines anderen eingearbeitet hat vergehen schon mal ein paar Stunden, bei komplexen Projekten sogar Tage, bis er sich halbwegs im Projekt zurecht findet. Und genau daher ist es nötig, dass alle Programmierer die gleiche Handschrift haben.
Und genau diese Handschrift festzulegen, das ist die Aufgabe, der ich mich derzeit verschrieben habe (Ja, ich weiß, ich hab Urlaub, blablabla). Es gibt viele Tools, die Entwickler dabei unterstützen zu prüfen, ob Regeln, die diese Handschrift beschreiben, eingehalten werden. Und aus einem solchen Tool stammt die erstaunliche Zahl von 1,29 Fehlern pro Zeile.

Checkstyle - Warnungen

Checkstyle - Warnungen


Für den Nicht-Programmierer sei kurz beschrieben, was da steht. Der Ausschnitt besagt, dass im geprüften Code genau 17.400 Zeilen Quelltext sind, der ausführbar ist, also Teil des Programms. Weitere 6.931 Zeilen sind Kommentare, in denen der Programmierer seine Arbeit dokumentiert hat. Diese sind aber für die Berechnung gar nicht relevant. Wir haben also 17.400 Zeilen ausführbaren Quellcodes. In diesen Zeilen sind insgesamt 22.412 Warnungen, dass sich nicht an die vorgegebene Handschrift gehalten wurde. Das ist absoluter Rekord!
Gut, an dieser Stelle muss ich natürlich zugeben, diese große Menge an Warnungen kommt daher, dass hier ein Standardsatz an Beschreibungen verwendet wurde, und noch kein angepasster Satz, der unseren allgemeinen Stil beschreibt. Trotzdem finde ich es erstaunlich, dass eine solche Zahl produziert werden kann.  Und bei diesen 17.400 Zeilen handelt es sich nur um einen kleinen Ausschnitt aus einem Projekt, nämlich um den zentralen Kern von Kapi Hospital. Meine nächste Aufgabe wird also sein, den korrekten Beschreibungssatz für unseren Stil zu bestimmen. Und dann mit hoffentlich wesentlich weniger Fehlern einen Schritt weiter gehen zu können…

4 comments for “Nur 1,29 Fehler pro Zeile…

  1. 12. Dezember 2011 at 0:58

    Na dann wünsch ich dir mal Viel Erfolg beim „Unters Volk bringen“ 😉

    • Marcus
      12. Dezember 2011 at 1:04

      Danke, den Spaß werden wir bestimmt alle haben 😉 Mittlerweile ist die Fehlerzahl drastisch gesunken, was unter anderem daran liegt, dass ich einige extrem restriktive Regeln rausgeworfen habe und einige andere umgeschrieben habe 😉
      Ich denke, der CodeStyle lässt sich damit bald ganz gut prüfen, zumindest im Bezug auf PHP-Projekte. Die meisten Regeln funktionieren auch noch mit JavaScript. Dann aber brauchts für ActionScript, C# und das sonstige gelöt, das wir nutzen, andere Lösungen.

  2. 15. Dezember 2011 at 21:43

    Man müsste ja nur mal die Objektorientierung ein bisschen beliebter machen… 🙂 das wäre dann schonmal ein Anfang

    • Marcus
      16. Dezember 2011 at 6:10

      Die Themen OOP und CodeStyle sind nun aber doch deutlich unabhängig voneinander 😉 Würdest du die Perversitäten kennen, die manche als „OOP“ tarnen wärst du froh, würde jeder nur Spaghetti-Code produzieren 😉

Comments are closed.