Tipps für einen sauberen Programmierstile
Zum Abschluss des Tutorials noch ein paar Tipps für einen sauberen Programmierstile bzgl. Funktionen:
- Eine Aufgabe pro Funktion - Eure Funktionen sollten nicht versuchen alle Aufgaben auf einmal zu lösen. Stattdessen macht es Sinn, pro Funktion nur eine Aufgabe zu lösen. Wenn ihr komplexer Aufgaben untergliedern könnt in kleinere Aufgaben, dann macht es Sinn dafür eigene Funktionen zu schreiben. Möchtet ihr Beispielsweise die Eingaben in einem Formular überprüfen und dann die Daten abspeichern, dann solltet ihr dies in mehreren Funktionen machen. Beispielsweise eine Funktion zum Überprüfen einzelner Felder, z.B. des E-Mail-Feldes, dann eine Funktion die überprüft das alle Felder korrekt ausgefüllt und schlussendlich eine Funktion zum Abspeichern des Formulars.
- Aussagekräftige Funktionsnamen wählen - Funktionsnamen wie a(), b() sind vielleicht kurz zu schreiben, aber sie sagen später wenig aus wenn ihr die Funktion in eurem Script aufruft. Wählt stattdessen aussagekräftige Funktionsnamen, so dass schon am Namen erkenntlich wird, was die Funktion macht. Falls ein aussagekräftiger Name zu lang wird ist dies vielleicht ein Hinweis, dass eure Funktion zu komplex ist und ihr diese lieber zerlegen solltet in unterschiedliche Funktionen?
- Keine echo-Ausgaben in Funktionen - Hier im Tutorial haben wir ab und zu Textausgaben per echo in den Funktionen gehabt. Dies ist allerdings schlechter Stile, denn später wenn ihr die Funktion aufruft könnt ihr nicht mehr beeinflussen ob ihr die Ausgabe haben wollt oder nicht. Stattdessen solltet ihr lieber mit returns arbeiten. Also statt einen Text per echo auszugeben, gebt diesen per return zurück und ihr seid später frei zu entscheiden, ob ihr den Text ausgeben wollt oder ob ihr den weiterverarbeiten wollt.
- Dokumentation der Funktion - Es empfiehlt sich, die Funktion kurz zu kommentieren. Schreibt dazu vor der Funktion einen
Kommentar. Oftmals dokumentiert man kurz die Funktionalität, die Parameter und den Rückgabewert. Schreibt diese Dokumentation bevor ihr die
Funktion schreibt, dies hilft euch einen klareren Stile zu haben.Eine gute und weit verbreitete Dokumentation kann wie folgt aussehen:
<?php /** * Überprüft ob der Benutzer volljährig ist. Ist dies so, wird true zurück gegeben * @param string birthdate Geburtsdatum des Benutzers * @param int adulthood Ab wie vielen Jahren ist man volljährig, per default 18 Jahre * @return boolean true, wenn der Benutzer volljährig, sonst false */ function isAdult($birthdate, $adulthood=18) { //Hier steht meine Code } ?>
Zuerst wird in dem Kommentar die grundlegende Funktion beschrieben. Gefolgt von den Parametern die wir mit dem Wort @param einleiten, gefolgt von dem Typ (z.B. String oder Int) und einer kurzen Beschreibung. Zuletzt steht der Rückgabewert den wir mit @return einleiten, gefolgt vom Typ des Rückgabewerts und erneut einer kurzen Beschreibung.Dies ist nur ein Beispiel wie ihr Funktionen kommentieren könnt, zwingend ist die Dokumentation nicht. Sie hilft euch aber, wenn ihr später nochmal auf den Code schaut.
Quelle: php-einfach.de
Comments