TYPO3 coding guidelines - Was ist beim Programmieren zu beachten und warum?

1. TYPO3 & in2code CodingGuidelines(PHP)

2. Introduction

3. Was sind CodingGuidelines Die CG definieren, wie TYPO3 Code, Dateien und Verzeichnisse strukturiert und formatiert sein sollten. CG liefern keine technischen Informationen und hilft nicht beim Programmieren.

5. LesbarkeitDie CG helfen, sich in unbekanntem Code (und das kann durchaus der eigene Code nach einem längeren Zeitraum sein) schnell und sicher zurechtzufinden. Das Einhalten der CG sichert eine skalierbare und sichere Erweiterung gerade bei der Arbeit im Team.

6. PHP Showcase

7. Finde den (die) Fehler functionxy () { $a = "<div style=color:blue;>Das ist ein Text</div>"; if ($b) $a = "<a href=quot;index.php?id=$_POST["var"]quot;>$a</a>"; $anzahl = $row['x'].'Keine Produkte gewählt'; mysql_connect($dbort,$dbuser,$dbpw); mysql_select_db($dbdb); $z=mysql_query("SELECT * FROM table"); while($datenvondatenbank=mysql_fetch_array($z)) { echo "Daten: $datenvondatenbank[links]"; } } Warnung: Zu intensive Betrachtung kann zu epileptischen Anfällen führen!

10. HTML Code stets in Templates auslagern

12. Texte in Sprachdateien auslagern (locallang)

14. Sinnvolle Variablennamen (Nur temporäre Variablen mit kurzer Schreibweise)

15. HTML Code stets in Templates auslagern

19. Stringwerte in Hochkommas können schneller geparst werden als in Anführungszeichen

22. Kommentare innerhalb des Codes

23. In einer eigenen Zeile davor bündig mit dem entsprechenden Code

24. Kommentare sind immer wichtig (vor allem wenn die Funktion nicht ersichtlich ist)

25. Debugausgaben

26. Diese müssen gut beschrieben sein (An- und Ausschalten)

27. IF/ELSE/ELSEIF

28. Leerzeichen vor und nach den runden Klammern

29. Nur zusammen mit geschweiften Klammern

30. Zeilenende

31. Unix

32. Keine Leerzeilen vor oder nach php tags (<?php … ?>)

33. Keine Leerzeichen am Ende einer Zeile

34. Zeilen sollen kürzer als 80 Zeichen sein

35. PHP Tags

36. Immer <?php (nie <?)

38. foreach statt while(list())

39. foreach vs. reset()

40. Dateinamen

41. So lang wie gewollt

42. Kleinschreibung

43. Klassen, Funktionen und Variablen

44. Klassenfunktion immer dokumentieren

45. Nur eine Klasse pro Datei

46. camelCase in der Schreibweise (kein Unterstrich)

47. Erstes Zeichen ist kleingeschrieben

48. Variablenname nicht im Parameterkommentar der Methoden aufführen

49. String Variablen

50. Hochkomma anstatt Anführungszeichen

51. Array