2015-09-08 43 views
1

我正在嘗試用我的正確信息爲我的項目創建一個PHP文檔。 我想創建對象的信息,在類的方法內創建。 不幸的是,PHPdoc無法識別我的函數內部的對象。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(); 
    } 
} 

什麼我定義錯了嗎?

+0

這本加工?/* @var $ oDomain_controll domain_controll */ –

+0

不幸的是,好像整個對象沒有被PHPdoc檢測到。 通常情況下,變量總是顯示在文檔中,即使沒有對它的評論。 該對象甚至沒有在文檔中顯示,類似於方法中定義的所有屬性? – Abayob

回答

0

我也問了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(); 
    } 
} 

謝謝您的回答詹姆斯:)

0
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對象名的className

+0

這不適用於我的模型。/** @var $ oDomain_controll app_controll blabla * / – Abayob

相關問題