TYPO3 coding guidelines

  • View
    1.821

  • Download
    1

Embed Size (px)

DESCRIPTION

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

Transcript

  • 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.
4. Warum braucht man CodingGuidelines

  • Sicherheit

5. LesbarkeitDie CG helfen, sich in unbekanntem Code (und das kann durchaus der eigene Code nach einem lngeren 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 = "

Das ist ein Text

";
if ($b)
$a = "$a";
$anzahl = $row['x'].'Keine Produkte gewhlt';
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 Anfllen fhren!
8. Auflsung I
functionxy() {

  • Sinnvolle Namen fr Methoden und Klassen vergeben

9. Sichtbarkeit der Methoden und Attribute vergeben (PHP5)$a = "

Das ist ein Text

";

  • Sinnvolle Variablennamen (Nur temporre Variablen mit kurzer Schreibweise)

10. HTML Code stets in Templates auslagern 11. Stringwerte in Hochkommas knnen schneller geparst werden als in Anfhrungszeichen$anzahl = $row['x'].'Keine Produkte gewhlt';

  • Smtliche Bezeichnungen und Hinweistext international verstndlich (Englisch)

12. Texte in Sprachdateien auslagern (locallang) 13. Vor und nach jedem . ein Leerzeichen einfgenif ($b)
$a = "$a";

  • IF Anweisungen immer mit Klammern

14. Sinnvolle Variablennamen (Nur temporre Variablen mit kurzer Schreibweise) 15. HTML Code stets in Templates auslagern 16. GET/POST Parameter nicht ungefiltert ausgeben