PHP Coding Standard |
 |
PHP Coding Standard |
|
| 1. | Vorwort |
| 2. | Sinn und Zweck eines Coding Standard |
| 3. | Regel 0: Immer wenn eine Regel gebrochen wird, muss das deutlich und erkennbar dokumentiert werden |
| 4. | Regel 1: Das Prinzip der Einfachheit: Don't make me think! |
| 5. | Regel 2: Dateien, die inkludiert werden, sollten mit "*.inc.php" enden oder in einem Unterverzeichnis liegen |
| 6. | Regel 3: Jede PHP-Datei muss das Copyright und einen Kommentar enthalten, der die Funktionalität beschreibt |
| 7. | Regel 4: Die Sprache für Kommentare und Bezeichner sollte Englisch sein |
| 8. | Regel 5: Jede Datei wird mit Änderungskommentaren und einem Zeitstempel versehen |
| 9. | Regel 6: Jede Funktion muss mit Kommentaren versehen werden |
| 10. | Regel 7: Lange Kommentare sollten mit /* und kurze mit // gemacht werden |
| 11. | Regel 8: Alle Bezeichner werden aussagekräftig und eindeutig definiert |
| 12. | Regel 9: Benennung von Variablen und Funktionen erfolgen mit Unterstrich und in Kleinbuchstaben |
| 13. | Regel 10: Konstanten werden in Großbuchstaben defniert |
| 14. | Regel 11: Auf keinen Fall Abkürzungen verwenden, die zweideutig sein können |
| 15. | Regel 12: Funktionen, Parameter und Rückgabewerte gut dokumentieren |
| 16. | Regel 13: Die Klammern für eine Funktion () stehen direkt am Funktionsnamen |
| 17. | Regel 14: Funktionen mit langen oder vielen Parametern müssen übersichtlich strukturiert werden |
| 18. | Regel 15: Der Code muss vom Design getrennt werden (Template Engine) |
| 19. | Regel 16: Alle Templates müssen validiert werden |
| 20. | Regel 17: Bezeichner einer Klasse werden mit Großbuchstaben voneinander getrennt |
| 21. | Regel 18: Keine magischen Zahlen |
| 22. | Regel 19: SQL-Befehle werden groß geschrieben |
| 23. | Regel 20: Variablen in Zählschleifen werden mit einem Buchstaben definiert |
| 24. | Regel 21: Trinitäts-Operatoren dürfen nicht verschachtelt werden |
| 25. | Regel 22: Trinitäts-Operatoren müssen Klammern enthalten |
| 26. | Regel 23: INSERT-Anweisungen müssen die einzelnen Spalten für die VALUES-Klausel enthalten |
| 27. | Regel 24: Code, der nicht benutzt wird, muss gelöscht werden |
| 28. | Empfehlung 1: Geschweifte Klammern werden im Allman-Stil eingerückt |
| 29. | Empfehlung 2: Jede Kontrollstruktur hat einen Block mit Klammern |
| 30. | Empfehlung 3: Zum Einrücken von Quellcode werden Tabulatoren verwendet |
| 31. | Empfehlung 4: Die Benutzung von Zahlen in Bezeichnern ist zu vermeiden |
| 32. | Empfehlung 5: Es sollte Subversion und ein Bugtracker-System benutzt werden |
| 33. | Empfehlung 6: Keine Anführungsstriche bei String-Deklarationen |
| 34. | Empfehlung 7: Debug-Informationen von Anfang an einbinden |
| 35. | Empfehlung 8: Werte für FOR-Schleifen richtig setzen |
| 36. | Richtig und Falsch 1: Klammern setzen und Abkürzungen |