9

phpDocumentorのこのメソッドの戻り型を文書化する適切な方法は次のうちどれですか？

方法1：

/**
 * @return array Foo array.
 */
public function foo() {
    return array(1, 2, 3);
}

方法2：

/**
 * @return integer[] Foo array.
 */
public function foo() {
    return array(1, 2, 3);
}

また、どちらの方法からもIDEへの影響はありますか？

編集：

PhpStormとNetbeans7.1以降のIDEの両方が2番目の方法をサポートしているようです。

4

2 に答える 2

17

どちらの方法も技術的には正しいですが、こちらの方がより具体的であるため (intそしてinteger互換性があるため)、「より良い」と見なされます。

@return int[]

ここに文書化されています：

http://www.phpdoc.org/docs/latest/guides/types.html

于 2012-08-09T16:44:43.223 に答える
7

この回答を書いている時点で、これらはphpDocumentor (およびおそらく他のPHPDoc実装) が配列を表すために受け入れられている方法です。

  1. unspecified、表現された配列の内容の定義は与えられません。例：@return array

  2. 単一の type を含むように指定されている場合、Type定義はリーダーに各配列要素の型を通知します。Typeその場合、特定の配列の要素として1 つだけが期待されます。例:も単一の型である@return int[]

    ことに注意してください。このキーワードを使用すると、各配列要素に任意の型が含まれていることを示すことができます。mixed

  3. 複数の型を含むように指定されている場合、Type定義は各配列要素の型をリーダーに通知します。各要素は、指定された任意のタイプにすることができます。例：@return (int|string)[]
于 2014-08-15T14:52:19.760 に答える