phpdoc注释规范 - 添加详细介绍

  • 作者:KK

  • 发表日期:2016.9.17


在方法说明的下面空一行然后开始写你的自由文本,最好是markdown,我下面就是用了markdown

class LoginManager{
	/**
	 * 登陆一个用户
	 *
	 * 例如:
	 *
	 * ```php
	 * $userInfo = $db->table('user')->where(['id' => 999])->one();
	 * App::$loginManager->login($userInfo);
	 * ```
	 *
	 * @param array $userInfo 用户信息
	 * @see 与用户表的结构相对应
	 * @param int $duration 登陆时长,0=不限时永久在线,大于0就是过期秒数
	 * @return bool 是否登陆成功
	 * @throws \Exception 当连接session服务器失败时
	 */
	public function login(array $userInfo, $duration = 0){}
}

效果: