Projektwerkstatt: Code Guideliner

Lesetipps

1. Projektwerkstatt: LegacySniffer
2. Statische Code-Analyse mit dem PHP Code Sniffer
3. Projektwerkstatt

Ich hatte euch ja erzählt, dass mein kleines schwarzes Notizbuch voll mit Ideen ist, deswegen kommt hier gleich schon die nächste nach dem LegacySniffer. Dieses Tool existiert natürlich auch noch nicht, aber anders wie beim LegacySniffer werde ich diesen wohl relativ zeitnah umsetzen, da ich denke, dass dies einen Mehrwert für diesen Blog generiert. Und wie wir ja alle wissen sind Unique Selling Points das wichtigste einer Webseite. Ich fang einfach mal an zu erklären, was der Coding Guideliner ist. Wie jeder weiß, versuche ich hier und da mal die eine oder andere Programmierrichtlinie zu definieren und ein paar Programmierparadigmen zusammenzustellen. Diese sollen in dem neuen Tool in einer Liste aufgezählt werden. Zu jeder Regel gehört dann ein Name, eine Beschreibung und den Vorteil, den man hat, wenn man diese Regel beherzigt. Jeder kann jetzt für sich die wichtigen Regeln auswählen und daraus ein für sich gültiges Regelset zusammenstellen, das dann auch als PDF ausgegeben werden kann. Wunderbar wäre es natürlich auch, wenn jede dieser Regeln noch eine Klasse für den PHPCodeSniffer bereitstellen würde, um sie zu validieren.
Diese Zusammenstellung kann für jedes Projekt oder jede Person auch hier gespeichert und immer wieder angesehen werden. Natürlich gibt es dann als erstes eine Liste mit schon existierenden Guidelines, wie zum Beispiel die von PEAR oder des Zend Frameworks. Wenn man das ganze dann noch ausbauen will, wäre eine Art Diff ein nettes Gimmick. Hier würden einfach zwei Richtlinien miteinander verglichen und die Unterschiede hervorgehoben werden.

Der Vorteil, den die User dabei haben, ist eine zentrale Stelle für ihre Coding Guidelines. Auch müssen sie sich nicht die Mühe machen, sich die Regeln einzeln zusammen zu suchen. Der Vorteil für phphatesme wären die vielen Backlinks, die dieses Tool generieren könnte.

5 Kommentare »

• 
  

  kb

  am 20. November 2008 um 09:42 Uhr

  Planst du ein Tool das Webbasiert Dateien einließt?

  Denn für Eclipse gibt es ein “Checkstyle”-Plugin, wo man Codingrichtlinien definieren kann. Vielleicht mag sich ja jemand die Mühe machen, wer eh PDT nutzt, dafür eine neue Richtlinie zu schreiben, falls es nicht schon welche gibt.

• 
  

  Ralf Siepker

  am 20. November 2008 um 09:43 Uhr

  Hi Nils,

  ich finde die Idee gut und setze eine Backlink. Ach nee, das hab ich ja sowieso schon gemacht

  bye, Ralf

• 
  

  Nils Langner

  am 20. November 2008 um 17:50 Uhr

  @kb: Das Tool soll php code sniffer Regeln generieren und ansonsten einfach eine Weboberfläche liefern, die man dazu verwenden kann die Regeln, die man befolgen möchte zu gruppieren. Ein Checkstyle Plugin wäre natürlich eine weitere schöne Möglichkeit diese Regeln zu verwalten. Da ich aber leider keine Ahnung von Eclipse Plugins habe, würde ich dies jemand anderem überlassen.

• 
  

  kb

  am 21. November 2008 um 09:49 Uhr

  Dazu musst ja nicht mal Ahnung von Plugins haben, sondern nur das XML-Schema verstanden haben
  Mich juckts atm aber nicht mehr wirklich, da Netbeans jetzt mit PHP-Support die imho beste IDE unter Linux bietet. Eclipse ist zu aufbläht und von ständigen Abstürzen geplagt.

• 
  

  Nils Langner

  am 21. November 2008 um 10:43 Uhr

  Bist du sicher, dass man nicht erstmal Checkstyle die Grammatik von PHP beibringen müsste?

RSS Feed für Kommentare zu diesem Artikel. TrackBack URL

Hinterlasse einen Kommentar