ne kurze blöde Frage was Kommentare angeht

    Ab und an, wenn ich Klassen benutze die ich mir ergoogelt habe, treffe ich desöffteren auf folgende Kommentarinhalte die dann auch hervorgehoben sind:

    PHP
    /**
*@var
*@return
*@param
**/


    Wozu sind die eigentlich gedacht?

    MFG
    Gim

    also ich würds mal spontan als "hilfe" ansehen. ich kenns von anderen sprachen bei
    größeren projekten. dort werden am anfang angaben gemacht über die variablen die
    verwendet werden (var), was bei funktionen zurück gegeben wird (return) und welche
    parameter übergeben werden müssen (param - optional oder fest).

    so kann jeder, der die klasse später bearbeitet sofort sehen was er aufruft und was er
    zurückbekommt...

    Ich habe das mal gesehen, jedoch nicht als kommentar, wie ich herausfinden wolllte wie man typehints&optionale parameter macht. Den genauen syntax weiss ich nicht, es kann aber sein dass man damit wie zumbeispiel in hohsprachen, wie driver auch schon sagte, klare regeln definiert.

    Code
    public String funktion (String argument, int argument2) {}
public String funktion (String argumebt, int argument2, int argument3) {}


    ==

    PHP
    function foo ($arg, $arg2, $arg3=null) {
     @param $arg String;
     @param $arg2 Integer;
     @param $arg3 Integer;
     @return String;
}


    ! Ungetestet

    Der, der weiß dass er nichts weiß, weiß mehr als der, der nicht weiß, dass er nichts weiß.

    Wer nach etwas fragt, geht grundsätzlich das Risiko ein, es auch zu bekommen!

    Einmal editiert, zuletzt von Tobse (18. August 2010 um 23:56)

    also in einer g4-hochsprache wie java nennt sich das ganze javadoc.
    das wird genutzt, um die doku zu erstellen, sprich für funktionsbeschreibungen und bietet die von driver angesprochene hilfe.
    ich denke mal die haben das für php auch so gemacht, ob da später noch ne doku draus generiert werden kann.. kein plan.
    aber ne hilfe in diesem sinne ist es allemal