Kommentare in Deinem PHP Script

Kommentare sind eine gute Möglichkeit an beliebiger Stelle des Scripts etwas zu schreiben. Das fängt schon mit den ersten Zeilen im Script an, wo oft ein Hinweis auf den Programmierer steht, den einzelnen Klassen, Funktionen, Variablen oder einfachen Bereichen wo kurz und knapp geschrieben wird was hier eigentlich passiert.



Gerade wenn man komplexe Scripte hat, kann man ansonsten schnell mal den Überblick verlieren. In dem Moment wo man sich gerade damit beschäftigt scheint das vielleicht nicht so wichtig zu sein, aber stellt Euch vor Ihr kümmert Euch eine Zeit lang um ein anderes Projekt und schaut dann nach ein paar Monaten noch einmal auf den Code. Dann seid Ihr über jeden Kommentar dankbar 😉
Das gleiche gilt übrigens auch wenn Ihr das Script weiter gebt. Hinweise im Scripts sind für Personen die das Script nicht selbst geschrieben haben Gold wert.

Wenn Du ein Kommentar in Deinem PHP – Script schreiben möchtest kannst Du das folgendermaßen machen:

Einige Beispiele für einzeilige Kommentare:

Wer jetzt etwas mehr Platz braucht und dem jetzt eine Zeile bei Weitem nicht ausreicht kann seinen Kommentar natürlich auch über mehrere Zeilen schreiben.
Dies wird auch gerne zum Auskommentieren von Programmcode benutzt. Ich benutze das aber auch gerne mal zum Testen.  Dabei befindet sich immer ein Teil des Scriptes in der Nähe in einem Kommentarbereich wo ich dann schnell mal was rauskopieren kann.

Ein Beispiel für Mehrzeilige Kommentare:

Die mehrzeiligen Kommentare lassen sich übrigens nicht verschachteln.

Auch wenn man jetzt natürlich überall Kommentare schreiben könnte, sollte man berücksichtigen das zu viel Text gerade bei größeren Projekten ziemlich aufhalten kann. Hilfreich sind auf alle Fälle Kommentare am Anfang des Scripts (Autor, Erstellungsdatum etc.),vor Klassen, Funktionen und Variablen falls sich das nicht über den Namen ableiten lässt. Hiermit kann man mit kurzen Worten eine unheimliche Hilfestellung bieten.

 



Das könnte Dich auch interessieren

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.