0800 - SPACEQUADRAT

Sauberer Code Zurück zur Übersicht

Über den Autor

Tarik User
http://argentinien-austausch.de

Inhalt

1. Kommentare
2. Bezeichnung von Variablen, Konstanten, Funktionen und Klassen
3. Einrücken von Funktionen, Kontrollstrukturen, Schleifen

Hallo und willkommen zu meinem Tutorial zum Thema 'Wie schreibe ich einen sauberen Code'.
Dieses Tut gilt für PHP und die meisten anderen Programmiersprachen auch.

1. Kommentare
Wieso sollte man kommentieren? Ganz einfach: Wenn ihr nach Monaten in euren Code schaut, werdet ihr euch nicht so schnell erinnern, was ein Codeblock macht. Daher kommentiert man möglichst knapp und aussagekräftig.
Manchmal macht man vor Funktionen auch eine Parameterliste als Kommentar, um zu wissen, welche Datentypen die Parameter haben oder was als Rückgabewert erwartet wird.
Oder man kommentiert Programmblöcke aus, weil man darin einen Fehler vermutet und ihn so lokalisieren kann.
Es gibt unterschiedliche Arten, wie man einen Kommentar erstellen kann:

a) Einzeiliger Kommentar
Der einzeilige Kommentar wird bei PHP mit // oder alternativ auch mit # eingeleitet.

  1.  
  2. <?php
  3.  
  4.   //Einzeiliger Kommentar echo "Diese Ausgabe ist auskommentiert";
  5.  
  6.   #Auch ein Einzeiliger Kommentar
  7.  
  8.   //Einzeiliger Kommentar 
  9. ?>
  10.  


b) Mehrzeiliger Kommentar
Der mehrzeilige Kommentar wird mit /* eingeleitet und endet beim */. Mit ihm kann man mehrere Zeilen auskommentieren.

  1.  
  2. <?php
  3.   /* Kommentaranfang
  4.  
  5.     echo "auskommentierte Zeile 1;
  6.  
  7.     echo "auskommentierte Zeile 2;
  8.  
  9.     echo "auskommentierte Zeile 3;
  10.  
  11.   Kommentarende */
  12.  
  13. ?>
  14.  

c) PHPDoc
PHPDoc unterscheidet sich nicht grundsätzlich vom mehrzeiligen Kommentar, es startet mit /** und endet mit */. Es wird für dafür verwendet um zu Kennzeichnen, wie Funktionen arbeiten, welche Parameter(-Datentypen) sie haben und was sie Zurückgeben.

  1.  
  2. <?php
  3.   /** multipliziert mit Hilfe der Addition zwei Zahlen
  4.  
  5.   *  @param:  int $zahl1
  6.  
  7.   *  @param:  int $zahl2
  8.  
  9.   *  @return: int
  10.  
  11.   */
  12.  
  13.   function mult ($zahl1, $zahl2<) {
  14.  
  15.     $ergebnis = 0;
  16.  
  17.       for($i = 1; $i <= $zahl2; $i++) {
  18.  
  19.         $ergebnis += $zahl1; // Addiert solange $zahl1 zu $ergebnis, bis $i == $zahl2
  20.  
  21.     }
  22.  
  23.     return $ergebnis;
  24.  
  25.   } 
  26. ?>
  27.  

Mehr zu PHPDoc hier.

2. Bezeichnung von Variablen, Konstanten, Funktionen und Klassen

a) Variablen
Variablen sollten immer gute und aussagekräftige Namen haben.
Will man z.B. eine E-Mail-Adresse in einer Variablen speichern um sie später auszugeben, sollte man die Variable auch entsprechend benennen:

  1.  
  2. <?php
  3.   $email = "emailadresse@hoster.tld";
  4. ?>
  5.  


Würde die Variable $var heißen, wüsstet ihr später nicht mehr, wofür die Variable ist und müsstet hochscrollen bis zur Deklaration der Variable um zu gucken, was die Variable beinhaltet.
Will man eine Variable erstellen, die aus mehreren Wörtern bezeichnet wird, werden die Wörter mit einem Großbuchstaben oder einem Unterstrich gekennzeichnet:

  1.  
  2. <?php
  3.   $meineErsteHomepage = "http://foo.bar";
  4.  
  5.   $meine_erste_homepage = "http://foo.bar";
  6. ?>
  7.  


In der Schule und Uni hab ich die erste Variante gelernt, allerdings findet man in diversen Tutorials auch die zweite.

b) Konstanten
Konstanten werden immer vollständig großgeschrieben. Man definiert Konstanten in PHP mit dem Befehl define(string NAME, mixed Wert). Mehrere Wörter als Bezeichnung werden mit einem Unterstrich getrennt.

  1.  
  2. <?php
  3.   define("MEINE_KONSTANTE", "foobar");
  4.  
  5.   define("PI", 3.14);
  6. ?>
  7.  


c) Funktionen
Funktionen werden wie Variablen benannt. Ihr Name sollte aussagen, was die Funktion macht. Berechnet ihr z.B. einen Winkel aus zwei Geraden, die sich schneiden, könnte die Funktion möglicherweise wie folgt heißen:

  1.  
  2. <?php
  3.   function berechneWinkel($gerade1, $gerade2){
  4.  
  5.     // Programmcode
  6.  
  7.   } 
  8. ?>
  9.  

Man weiß sofort, was diese Funktion macht und muss sich nicht erst einmal durch den Programmcode arbeiten oder einen größeren Kommentar dazu schreiben.

d) Klassen
Und auch Klassen sollten passende Namen haben. Außerdem werden Klassen immer mit einem Großbuchstaben begonnen, die restlichen Buchstaben sind klein, es sei denn man baut ein weiteres Wort ein, das wird dann wieder mit einem Großbuchstaben begonnen. Will man eine Klasse für Pflanzen machen, sollte diese auch so heißen:

  1.  
  2. <?php
  3.   class Pflanzen {
  4.  
  5.     // Variablen, Funktionen, ...
  6.  
  7.   }
  8. ?>
  9.  

3. Einrücken von Funktionen / Kontrollstrukturen / Schleifen 

  1.  
  2. <?php
  3. $begruessung="Hallo";
  4. $name="David";
  5. function begruesseUser ($begruessung,$name) {
  6. echo $begruessung." ".$name}
  7. for($i=0;$i<10;$i++)
  8. echo$i."<br />n";
  9. echo("Das ist eine neue Zeile.<br />n";)
  10. $a=$_GET['ID'];
  11. switch(a){
  12. case 0:
  13. echo"ID war 0";
  14. break;
  15. case 1:echo "ID war 1";
  16. break;
  17. case 2:
  18. echo "ID war 2";break;
  19. default:
  20. if($a<0){
  21. echo "Es wurde keine gültige ID übergeben";
  22. }else{
  23. echo "Die ID war zu groß";
  24. }
  25. break;
  26. }
  27. echo "Tschüss";
  28. ?>
  29.  

(Der Code muss nun keinen Sinn machen)
Ganz schön unübersichtlich, nicht wahr?
Daher immer einrücken und auch mal Leerzeichen einbauen!

Derselbe Code, aber schön eingerückt und mit Leerzeichen gespickt:

  1.  
  2. <?php
  3.   $begruessung = "Hallo";
  4.   $name = "David";
  5.   function begruesseUser($begruessung, $name;) {
  6.  
  7.     echo($begruessung . " " . $name);
  8.  
  9.   }
  10.  
  11.   for($i = 0; $i < 10; $i++) {
  12.  
  13.     echo($i."\n");
  14.  
  15.   }
  16.  
  17.   echo("Das ist eine neue Zeile\n";);
  18.  
  19.   $a = $_GET['ID'];
  20.   switch($a) {
  21.     case 0:
  22.  
  23.       echo "ID war 0";
  24.  
  25.     break;
  26.  
  27.     case 1:
  28.  
  29.       echo "ID war 1";
  30.  
  31.     break;
  32.  
  33.     case 2:
  34.  
  35.       echo "ID war 2";
  36.  
  37.     break;
  38.  
  39.     default:
  40.  
  41.       if($a < 0;) {
  42.  
  43.         echo "Es wurde keine gültige ID übergeben" ;
  44.  
  45.       } else {
  46.  
  47.         echo "Die ID war zu groß";
  48.  
  49.       }
  50.  
  51.       break;
  52.  
  53.     }
  54.  
  55.   echo "Tschüss"; 
  56.  
  57. ?>
  58.  

Viel sauberer, wie ich finde. Außerdem besser lesbar, man weiß gleich, wo switch, if und else beginnen und aufhören.

Ich nutzte zum Einrücken immer zwei Leerzeichen und eingerückt wird nach einer Kontrollstruktur, Schleife, Funktion oder Klasse.

  1.  
  2. <?php
  3.   if(bedingung1;) {
  4.  
  5.     // 4 Leerzeichen zum Einrücken
  6.     Hier der if-Programmcode
  7.  
  8.     if(bedingung2;) {
  9.  
  10.       // 6 Leerzeichen zum Einrücken
  11.       Hier der if-Programmcode
  12.  
  13.     } else {
  14.  
  15.       // 6 leerzeichen zum Einrücken
  16.       Hier der else-Programmcode
  17.  
  18.     }
  19.  
  20.   } else {
  21.  
  22.     // 4 Leerzeichen zum Einrücken
  23.     Hier der else-Programmcode
  24.  
  25.   } 
  26.  
  27. ?>
  28.  

  1.  
  2. <?php
  3.   for($i = 0; $i < 10; $i++) {
  4.     // 4 Leerzeichen zum Einrücken
  5.     $j = 3;
  6.     while($j > 0) {
  7.       // 6 Leerzeichen zum Einrücken
  8.       $j--;
  9.     }
  10.  
  11.     $k = 3;
  12.     do {
  13.  
  14.       // 6 Leerzeichen zum Einrücken
  15.       echo "Hallo";
  16.       $k--;
  17.  
  18.     } while($k > 0);
  19.  
  20.   } 
  21.  
  22. ?>
  23.  

  1.  
  2. <?php
  3.   function meineFunktion($param1, $param2;) {
  4.  
  5.     // 4 Leerzeichen zum Einrücken
  6.     $ergebnis = 0;
  7.  
  8.     for($i = 0; $i < $param2; $i++) {
  9.  
  10.       // 6 Leerzeichen zum Einrücken
  11.       $ergebnis += $param1;
  12.  
  13.     }
  14.  
  15.     return $ergebnis;
  16.  
  17.   } 
  18. ?>
  19.  

  1.  
  2. <?php
  3.   class Auto {
  4.  
  5.     // 4 Leerzeichen zum Einrücken
  6.     public $farbe;
  7.  
  8.     public getFarbe() {
  9.  
  10.       // 6 Leerzeichen zum Einrücken
  11.      return $this->farbe;
  12.  
  13.     }
  14.  
  15.   } 
  16. ?>
  17.  

Schwer ist das alles nicht, man muss sich nur daran gewöhnen, es hilft später aber, wenn ihr Jemanden den Code zum durchschauen gebt oder selbst den Code nach einiger Zeit wieder anschaut.

Noch ein kleiner Tipp, um Klammern vergessen vorzubeugen :

Sobald ihr eine Klammer, ob geschweift oder normal, öffnet, schließt sie gleich wieder und schreibt den Code dann zwischen den beiden Klammern.
So könnt ihr schon kleine Fehler verhindern.

So, das war nun mein Tutorial. Falls ihr einen Fehler entdeckt, behaltet ihn nicht, ich bin nicht fehlerfrei und werde diesen gerne verbessern.

Edit: Änderungen nach Anregung durch "der_designer" und "Ghostridah" und überarbeitet von XMMX nach Zerstörung durch die Seitenumstellung.

Kommentare Kommentar schreiben

Es wurden noch keine Kommentare geschrieben.