How to PHPDoc an anonymous function when passed as an argument?

Question

How should I document an anonymous function when it's passed as an argument? For example:

// Call my_function(), passing 2 arguments.
my_function( 'foo', function() {
    // Body of the anon function I'd like to document.
} );

Thanks in advance.

Answer 1

To document that a function accepts a Closure, I'd suggest callable:

/**
 * Do something.
 * @param callable $code
 */
function foo(callable $code) {
}

Regarding the commentary, PHPDoc uses DocBlocks, which the PHP engine Tokenizer only recognizes above formal definitions. Thus, PHPDoc will not see this:

/**
 * My closure.  PHPDoc will *not* parse this, because it's not a formal definition.
 * @param string $name
 */
$closure = function ($name) { return $name; };