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

时间:2012-07-16 03:55:28

标签: symfony doctrine-orm

在symfony2和doctrine 2.我有这个

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

现在我想知道它是否解决了目的,或者它是否在数据库中使用@param@return注释执行任何操作,或仅用于文档

2 个答案:

答案 0 :(得分:6)

phpDocumentor docs中解释了

@param。它与Symfony2无关。

答案 1 :(得分:0)

链接已过时。

这是目前这个好地址的链接。

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

下面,无论如何都是解释的第一行......

  

@param标记用于记录函数或方法的单个参数。

     

使用@param标记,可以记录函数或方法的单个参数的类型和功能。如果提供它必须包含一个类型来表明预期的内容;另一方面,描述是可选的,但在复杂结构的情况下推荐,例如关联数组。