I think PHP_Codesniffer can indicate when there is no docblock — see the examples of reports on this page (quoting one of those) : ——————————————————————————– FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S) ——————————————————————————– 2 | ERROR | Missing file doc comment 20 | ERROR | PHP keywords must be lowercase; expected “false” but … Read more
This is how I do it instead: /** * Class constructor. * * @param array $params Array containing the necessary params. * $params = [ * ‘hostname’ => (string) DB hostname. Required. * ‘databaseName’ => (string) DB name. Required. * ‘username’ => (string) DB username. Required. * ‘password’ => (string) DB password. Required. * ‘port’ … Read more
A single line is all you need: /* @var $varName Type_Name */ See this article in the NetBeans PHP Blog: https://blogs.oracle.com/netbeansphp/entry/defining_a_variable_type_in Note: At least, in version 8.2; The key seems to be: The single asterisk (/* instead of /**). Placing the type after the variable name. Having nothing before and after the type-hinting (except white-space, … Read more
You can’t document each key, but you can tell phpDocumentor what type it is. You could do something like this: /** * Form the array like this: * <code> * $array = array( * ‘id’ => ‘foo’, // the id * ‘class’ => ‘myClass’, // the class * ); * * </code> * * @var … Read more
In the PhpStorm IDE from JetBrains, you can use /** @var SomeObj[] */, e.g.: /** * @return SomeObj[] */ function getSomeObjects() {…} The phpdoc documentation recommends this method: specified containing a single type, the Type definition informs the reader of the type of each array element. Only one Type is then expected as element for … Read more