dedlfix: Kommentieren in PHP

Beitrag lesen

Tach!

was will man mit dieser raumgebenden ersten Kommentar-Methode erreichen? für mich sehr verwirrent

Erreichen will man, dass ein typischerweise in IDEs eignebauter Parser anspringt und aus den Kommentaren Code-Dokumentation macht. Die ist dann im ganzen Projekt verfügbar und zeigt bei der Eingabe z.B. von Funktionsnamen die definierten Parameter und Rückgabewerte.

Dazu muss der Kommentarblock aber mit zwei Sternchen beginnen (also /**), sonst ignoriert der PhpDoc-Interpreter diesen Kommentarblock. Damit kann man unterscheiden zwischen dokumentationsfähigen Kommentaren und welchen, die einfach nur so im Code stehen.

P.S.: die 3 Methode finde ich reizvoller und eleganter da sie nur ein zeichen enthält das den kommentar einleitet. außerdem ist es von der "oberfläche" her größer als das Sternchen.

Dann braucht man aber kein @param und ähnliches, weil es eh nicht interpretiert wird.

dedlfix.