PHPdoc不检测对象(和其他属性)


PHPdoc does not detect object (and other properties)

我正试图用正确的信息为我的项目创建一个PHPdocument。我正在尝试为在类的方法中创建的对象创建信息。遗憾的是,PHPdoc无法识别我的函数中的对象。

代码如下:

class app_controll
{
/**
  * This function starts the application. All the functionality starts here.
  * @return Objects Method returns all the objects and functions needed to build a page.
  */
public function start_application() 
     {
     /**
      * The domain_controll object contains domain information.
      * @var object domain_controll
      */
     $oDomain_controll = new domain_controll();
     }
}

我定义错了什么?

class app_controll
{
/**
  * This function starts the application. All the functionality starts here.
  * @return Objects Method returns all the objects and functions needed to build a page.
  */
public function start_application() 
     {
     /**
      * The domain_controll object contains domain information.
      * @var $oDomain_controll domain_controll
      */
     $oDomain_controll = new domain_controll();
     }
}

用法为:@var objectName className

我还在Github上问了这个问题。我收到了詹姆斯·皮特曼的回复:

在这种情况下,$oDomain_controll将是一个内部变量,可见仅在start_application((函数中。没有任何理由将其包含在API文档中,因为它不可用或app_controll类的使用者可以查看。如果你想如果它是app_controll类的公共成员,则应该声明它start_application((函数之外:

class app_controll()
{
    /**
     * The domain_controll object contains domain information.
     * @var domain_controll
     */
    public $oDomain_controll;
    public function start_application()
    {
        $oDomain_controll = new domain_controll();
    }
}

感谢您的回答James:(