@param注释在symfony2类文件中的作用是什么

Question

In the symfony2 and doctrine 2. I have this

 /**
  * Find a user by its username.
  *
  * @param string  $username
  * @return UserInterface or null if user does not exist
  */
function findUserByUsername($username);

Now i want to know that does it solve nay purpose or does it do anything in database with those @param and @return annotation or they just for documentation

Answer 1

@param is explained in the phpDocumentor docs . It has nothing to do with Symfony2.

Answer 2

The link is outdated.

Here is a link to a good address at this present moment.

https://www.phpdoc.org/docs/latest/references/phpdoc/tags/param.html

Below, the first lines of the explanation in any case...

The @param tag is used to document a single argument of a function or method.

With the @param tag it is possible to document the type and function of a single argument of a function or method. When provided it MUST contain a Type to indicate what is expected; the description on the other hand is OPTIONAL yet RECOMMENDED in case of complicated structures, such as associative arrays.