nicht angemeldet
AugeHallo
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.
Mist! Ich wusste, dass noch etwas fehlt. Beim Schreiben habe ich noch dran gedacht. Danach zweimal editiert und immer noch nicht ganz richtig. Immer is irgendwas. *grml*
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.
Es spricht aber auch nichts dagegen, falls mandiese Notation selbst für hilfreich hält. Sie erfüllt halt nur nicht den Zweck, zu dem sie entwickelt wurde.
Tschö, Auge
Wir hören immer wieder, dass Regierungscomputer gehackt wurden. Ich denke, man sollte die Sicherheit seiner Daten nicht Regierungen anvertrauen.
Jan Koum, Mitgründer von WhatsApp, im Heise.de-Interview