したがって、PHPDoc では、メンバー変数宣言の上にその型のヒントを指定できます@var
。すると、PHPEd などの IDE は、どのタイプのオブジェクトを操作しているかを認識し、その変数のコード インサイトを提供できるようになります。
<?php
class Test
{
/** @var SomeObj */
private $someObjInstance;
}
?>
これは、後でオブジェクトを反復処理するときに適切なヒントを取得できるように、オブジェクトの配列に対して同じことを実行する必要が生じるまでは、うまく機能します。
では、メンバー変数が配列であることを指定する PHPDoc タグを宣言する方法はありますかSomeObj
?たとえば@var
、配列だけでは不十分で、@var array(SomeObj)
有効ではないようです。
ベストアンサー1
JetBrains の PhpStorm IDE では、/** @var SomeObj[] */
次のように使用できます。
/**
* @return SomeObj[]
*/
function getSomeObjects() {...}
のphpdoc ドキュメントこの方法を推奨します:
単一の型を含むように指定されている場合、型定義は各配列要素の型を読者に通知します。指定された配列の要素として期待される型は 1 つだけです。
例:
@return int[]