Search code examples
phpdocumentationphpdoc

Proper way to denote array data type for phpDocumentor?

Which of the following is the proper way to document the return type of this method for phpDocumentor?

Method 1:

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

Method 2:

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

Also, are there any IDE implications from either method?

Edit:

It appears that both PhpStorm and Netbeans 7.1+ IDEs support the 2nd method.

Solution

  • Both methods are technically correct, but this one is considered 'better' because it's more specific (int and integer are interchangeable):

    @return int[]

    Documented here:

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