Wie dokumentiert man ein Array von [Typ]?

sagen, dass ich eine Funktion wie diese:Wie dokumentiert man ein Array von [Typ]?

function theFunction() { 
    $arr = array(); 
    for ($i=0;$i<10;$i++) { 
     $arr[] = new theObject($i); 
    } 
    return $arr; 
}

ich den Rückgabetyp der Funktion dokumentieren muß. Ich könnte natürlich nur array verwenden, aber das liefert nicht alle Informationen, die bereitgestellt werden können, und sagt dem Entwickler nicht viel über die wahre Natur der Funktion.

Wie dokumentiere ich den Typ "Array von [Typ]" in PHPDoc?

Quelle

2013-06-11 Keelan

haben Sie '@var Objecttype []' versucht? – Robert

@Robert nein, aber die Suche ergab ein Ergebnis! :) http://www.phpdoc.org/docs/latest/for-users/types.html#arrays – Keelan

Siehe https://github.com/phpDocumentor/phpDocumentor2/issues/650 –

Aus der Dokumentation von phpDocumentor

Der nach Typ dargestellte Wert kann ein Array sein. Der Typ muss nach dem Format einer der folgenden Optionen definiert werden:

unspezifiziert, keine Definition der Inhalte der dargestellten Anordnung gegeben. Beispiel: @return array

spezifizierte einen einzigen Typen enthält, informiert die Typdefinition die Leser des Typs jeden Array-Elements. Es wird dann nur ein Typ als Element für ein gegebenes Array erwartet.

Beispiel: @return int[]

Bitte beachten Sie, dass gemischtes ist auch eine einzige Art und mit diesem Begriff ist es möglich, um anzuzeigen, dass jedes Array-Element jede mögliche Art enthält.

angegeben, die mehrere Typen enthält, informiert die Typdefinition den Leser über den Typ jedes Arrayelements. Jedes Element kann einen beliebigen der angegebenen Typen aufweisen. Beispiel: @return (int|string)[]

Hinweis
viele IDEs wahrscheinlich diese Schreibweise noch nicht unterstützen.

Quelle

2013-06-11 11:12:15 Robert

Für mehrere Typen scheint PHPSstorm auch okay mit 'int [] | string []', aber ich bin nicht sicher, dass es über '(int | string) []' empfohlen werden sollte. – gapple

Ich glaube nicht, dass int [] | string [] dasselbe bedeutet wie (int | string) []. Die erste repräsentiert ein Array von int-Elementen oder ein Array von string-Elementen. Letzteres stellt ein Array dar, das Elemente beider Typen gemischt haben kann. –

Wenn ich mich recht erinnere, liefern Sie den Rückgabetyp und eine Beschreibung, können Sie es nicht in der Beschreibung eingeben?

/** 
* blah 
* @return array array of types 
*/

Quelle

2013-06-11 11:11:07 Dale

Das mache ich jetzt , aber es wäre besser, den Standard Weg zu verwenden, wenn es existierte :) – Keelan

@CamilStaps Ja, ich nehme an, es würde :) – Dale

In PHPDoc können Sie die folgenden Aktionen für Mitglieder Type Hinting-Array:

@var array<\My\Folder\ClassName>

Quelle

2015-04-08 12:29:41 Wilt

Wie dokumentiert man ein Array von [Typ]?

Antwort

Verwandte Themen