Is it possible to write PHPDoc documentation for @param without specifying the type?

Question

I'm using PhpStorm. When I put the following PHPDoc documentation for a function:

/**
 * @param $id application identifier
 */
public function foo($id)

And I run the "Quick documentation" (Ctrl + Q) command for the function in PHPStorm, it shows this:

Parameters: App\Models\Application $id identifier

It looks like for some reason, the IDE is interpreting the first word of the parameter description, application, as the type for the parameter. I don't want to specify the type of the parameter (I don't know what it is), I just want to add a brief description about the parameter in the documentation. What should I do?

Use mixed type (or some other generic) then. PHPDoc requires type. In your case, IDE treats it as PHPDoc-like syntax where type goes after the name. — LazyOne
– LazyOne, Commented Apr 4, 2019 at 18:37

Don't Panic · Accepted Answer · 2019-04-04 18:37:35Z

1

If you don't know what it is, you can use mixed. The type goes before the $id and the part after $id will be used as the description.

/**
 * @param mixed $id application identifier
 */
public function foo($id)

answered Apr 4, 2019 at 18:37

Don't Panic

41.9k11 gold badges70 silver badges87 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Is it possible to write PHPDoc documentation for @param without specifying the type?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related