nicht angemeldet
AugeHallo
@param is sehr sinnvoll und andere schlüsselbegriffe auch. Die Art eineder Kommentare einer "Java-Konvention" macht mich stutzig.
Wenn du schon weißt, dass es sich bei dieser Art zu kommentieren um eine „Java-Konvention“ handelt, hättest du auch mal gleich danach suchen können und wärst erst auf JavaDoc und dann auch gleich auf phpDocumentor gestoßen.
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.
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.
Kannst du machen, wie du willst oder es das Projekt, an dem du beteiligt bist, regelt.
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