phpdoc注释规范 - 介绍一个方法 ¶

• 作者：KK

• 发表日期：2016.9.17

class LoginManager{
	/**
	 * 登陆一个用户
	 * @author 李四
	 * @param $userInfo 要登陆的用户信息
	 * @param int $duration 登陆时长（秒），0表示不过期
	 * @return bool 是否登陆成功
	 * @throws \framework\lib\Exception 当连接缓存服务器失败时
	 */
	public function login(array $userInfo, $duration = 0){
		//...
	}
}

• @author 作者名称 这个和类的介绍一样，不废话咯

• @param 类型 变量名 参数的作用 介绍一个方法/函数的参数，包括参数的类型，参数变量名（会有多个参数嘛）以及这个参数的作用

• @return 类型 返回值说明 介绍返回的是什么东西，如果没有return则不用写这个@return了

• @throws 异常类型 异常产生说明 介绍这个方法在怎样的情况下会抛出什么异常

效果如下:

• PS:

  对于函数注释也同样适用

  而且提醒一下，return里如果返回的是一个x\y\Z的类，当你的方法处于a\b命名空间下，此时如果@param，@return等任何描述到类的地方如果写了x\y\Z就会导致文档生成器从当前命名空间下开始查找类，变成a\b\z\y\Z了，所以应该写成\x\y\Z才能确保从根命名空间开始查找类，而如果要返回本类的话则直接写自己的类名就行了，因为从当前命名空间下就能找到自己嘛