php的注释/注解

php中的注解, 分为类注解和属性注解.

用注释来定义类的属性

namespace app\common\model;

use think\Model;

/**
 * Class User
 * @property string $name;
 * @property string $gender;
 */
class User extends Model{
    protected $name = 'users';
}

$m_User = new User();
echo $m_User->name; //这里就可以使用IDE的自动提示功能了
echo $m_User->gender; //这里就可以使用IDE的自动提示功能了

这种对于模型对象实例化后的栏位(column)调用比较友好.

用来定义未知类型变量的属性

namespace app\user\controller;

use app\common\service\UserService;
use think\Controller;

class BaseController extends Controller
{
    /**
     * @var UserService
     */
    protected $userService;

    protected function _initialize()
    {
        $this->userService = new UserService();
        if ($this->userService->isGuest()) {
            $this->redirect('user/signin');
        }
    }
    protected function userId()
    {
        return $this->userService->userId(); //这里就可以使用IDE的自动提示功能了
    }
}

再比如:

/ ** @var string | null 应包含描述* /
protected $ description = null;

  /**
   * @var string $name 变量描述
   * @var string $description 变量描述
   */
  protected $name, $description;

可以参考 https://www.jianshu.com/p/e7d4b05ba715, 了解更多.

注意: @前必须有一个空格.