Warum den PHP-Variablentyp in einem Kommentar deklarieren?

Ich bin ziemlich neu in PHP und habe gerade angefangen, NetBeans zu verwenden, um meinen PHP-Code zu entwickeln.

Aus heiterem Himmel, als ich eine Variable in eine Abfrage eingab, tauchte ein Dialog auf und forderte mich auf, einen Kommentar zu vervollständigen, um den Variablentyp zu speichern. Ich habe einige Nachforschungen angestellt und festgestellt, dass dies ein beliebtes Feature von NetBeans zu sein scheint, aber ich konnte keine Informationen finden, die mir das erklären könnten warum dies war der Fall.

Warum sollte jemand den Typ einer PHP-Variablen in einen Kommentar einfügen? Ist es für Entwicklungszwecke oder kommt es tatsächlich dem Code selbst zugute? Ist es integriert oder optional?

Hinzufügen des Typs in a @var -Tag im Kommentar Ihrer Methode ermöglicht es NetBeans, Ihnen die Codevervollständigung anzuzeigen. Dies ist natürlich optional, aber es ist immer eine gute Idee, Ihren Code vollständig zu dokumentieren.

Bearbeiten: Ein Tipp für NetBeans zum automatischen Generieren der Kommentare für Sie ist die Verwendung der /** Erweiterung. Platzieren Sie dazu einfach den Cursor über der Eigenschaft oder Methode, die Sie dokumentieren und eingeben möchten /** und drücken Sie dann die ENTER Schlüssel. Dadurch wird ein Kommentar im phpDoc-Stil erweitert und die entsprechenden Tags hinzugefügt.

Bearbeiten 2:
Du kannst den … benutzen @var -Tag auf einer Eigenschaft und Sie können die verwenden @param -Tag für eine Methode, um den gleichen Effekt mit Parametern zu erzielen, die an eine Methode übergeben werden.

Verwendung der @var -Tag auf einer Eigenschaft gibt Ihnen Codehinweise, während Sie die Eigenschaft überall dort verwenden, wo sie sichtbar ist:

/**
 *
 * @var My_Type
 */
private $_myProperty;

Verwendung der @param -Tag für eine Methode gibt Ihnen Codehinweise, während Sie den Parameter innerhalb der Methode verwenden:

/**
 *
 * @param My_Type $obj 
 */
public function myMethod($obj) {

}

Eine andere Möglichkeit, einen ähnlichen Effekt zu erzielen und gleichzeitig ein gewisses Maß an Typsicherheit zu bieten, ist die Verwendung von PHPs geben Sie Hinweise ein Mechanismus:

public function myMethod(My_Type $obj) {

}

Beachten Sie, dass diese Methode den in der Methodensignatur angegebenen Typ hat. NetBeans stellt jetzt die gleiche Codevervollständigung innerhalb der Methode bereit, die mithilfe von verfügbar ist @param Tag und PHP erzeugt eine E_RECOVERABLE_ERROR wenn der an die Methode übergebene Typ nicht derselbe Typ ist, der angegeben wurde. Sehen PHP-Dokumentation zu Fehlern und wie Sie damit umgehen, wenn Sie mehr über den obigen Fehler erfahren möchten.

Ich vermute du redest von sowas:

/**
 * @var SimpleXMLElement $xml
 */
private $xml;

Dies wird so genannt phpDoc-Kommentar. Es ermöglicht Ihnen, API-Dokumentation zu generieren (wie dieser zum Beispiel). Darüber hinaus unterstützen die meisten IDEs, einschließlich Eclipse und NetBeans, diese Syntax und bieten dynamische Codevervollständigung usw.

Wenn Sie den Typ einer Variablen in dem Fall deklarieren möchten, in dem die Variable keine Klasseneigenschaft ist, sondern nur eine Variable, die einen Rückgabewert enthält, verwenden Sie Kommentare mit einem Stern, gefolgt von @var, gefolgt von Ihrem Variablennamen und schließlich gefolgt vom Typ dieser Variablen. Zum Beispiel:

/* @var $errorMessage NotificationMessage */
$errorMessage= $allMessages->rewind()->current();

teilt NetBeans oder PhpStorm mit, dass $errorMessage eine Instanz von NotificationMessage ist, und Sie sollten die Codevervollständigung für diese Variable erhalten.

Obwohl Netbeans es für die automatische Vervollständigung verwenden, ist es oft nützlich, um Ihren Code zu dokumentieren:

In diesem Fall wissen Sie, was diese Methode bekommt und was sie zurückgibt, aber innerhalb des Codes haben Sie keine Ahnung, was passiert

/**
 * Returns some stuff
 * @param string $someObj
 * @return array
 */
public function someMethod($someObj) {
    $factoredObj = getObject($someObj); //you are not sure what type it returns
    $resultArray = $factoredObj->toArray();
    return $resultArray;
}

Sie können es mit kommentieren /* @var $variable type */ innerhalb des Codes

/**
 * Returns some stuff
 * @param string $someObj
 * @return array
 */
public function someMethod($someObj) {
    /* @var $factoredObj someType */
    $factoredObj = getObject($someObj);
    $resultArray = $factoredObj->toArray();
    return $resultArray;
}

oder

$factoredObj = getObject($someObj); /* @var $factoredObj someType */

Da PHP eine loose/duck-typisierte Sprache ist, können diese Typhinweise Ihnen oder anderen helfen, zu verstehen, was vor sich geht, wenn Sie ein großes Programm erstellen, falls ein Problem auftreten sollte. Erwarten Sie beispielsweise einen gemischten Typ und senden Sie eine Ganzzahl.