PHP CodeSniffer: Integration in Netbeans

Werbung

Die Qualität des PHP Codes entscheidet letztendlich auch über den Erfolg des gesamten Projektes. Schnell mal hier einen Block reingehackt und dort einen, weil es ja schnell gehen muss und schon steht man nach Wochen, spätestens nach Monaten vor einem Problem.

Es ändert sich ja nichts

Die fälligen Änderungen lassen sich nicht mehr einfach integrieren, es werden Zeilen gefunden, die nicht dokumentiert sind und woher der Code stammt, weiß auch keiner mehr. Nicht selten ist es der eigene Code wegen dem man in dem Augenblick die Hände über den Kopf schlägt.

Als Hilfe für sauberen Code, gibt es das PEAR Projekt PHP_CodeSniffer von Greg Sherwood. PHP CodeSniffer analysiert den PHP Code und gibt Tipps für eine bessere Gestaltung und auch Hinweise auf fehlende Dokumentationen.

Dabei werden einfache Regeln aufgestellt, die sogenannten Coding Guidelines. Sobald PHP CodeSniffer aus dem PEAR Projekt installiert ist, kann auch direkt mit der Analyse begonnen werden.

Wie PHP CodeSniffer genau funktioniert, erfahrt ihr hier.

Wir brauchen Birnen

PEAR (Birne) ist eine lose Sammlung von nützlichen Komponenten rund um PHP. Diese können einfach in bestehende Projekte eingebaut werden. Wir kümmern uns jetzt aber nur um den PHP CodeSniffer.

Werbung

Wie man PEAR auf den verschiedenen Systemen installieren kann, ist jetzt nicht Teil des Tutorials. Dies kann aber hier nachgelesen werden.

Ist PEAR installiert, geht es mit folgenden Schritten weiter:

1. PHP CodeSniffer installieren

2. PHP_MD (Mess Detector) installieren

3. Netbeans PHP CodeSniffer Plugin installieren

Konfigurieren und anpassen

Die eigentliche Installation ist damit abgeschlossen. In Netbeans finden wir in den Einstellungen unter PHP jetzt zwei neue Tabs. Einmal phpMD und phpCodeSniffer. Hier können und müssen die Einstellungen für die beiden Plugins vorgenommen werden.

Wichtig sind vor allem die Pfade zur jeweiligen ausführbaren Datei. Unter phpCodeSniffer stellen wir noch den gewünschten Standard ein. Ich selbst benutze den Zend Standard, allerdings sind auch eigene Standard’s und Kombinationen aus bereits vordefinierten Standard’s möglich.

Wurde alles richtig einstellt, dann wird der Code, sobald eine PHP Datei in Netbeans geöffnet wird, analysiert. Die Ergebnisse finden sich in dem Tasks Fenster.

 

Hat dir der Beitrag gefallen? Dann würde ich mich sehr freuen, wenn du ihn weiterempfehlen würdest.Share on FacebookShare on Google+Tweet about this on Twitter

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.