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:
// Einzeiliger Kommentar /* Einzeiliger Kommentar */ echo 'Dein Code'; // Dein einzeiliger Kommentar echo 'Dein Code'; /* Dein einzeiliger Kommentar */
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:
/* Hier könnte Dein Kommentar auch ruhig ĂŒber mehrere Zeilen stehen. */
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
1 Comment
Hab bis jetzt nur die Schreibweise // gekannt. HĂ€tte mir viel Zeit erspart, wenn ich die Schreibweise /*…*/ schon vorher gekannt hĂ€tte.