2012-03-03 42 views
0

我想了解如何正確地爲phpdocumentor文檔中的數組屬性。如何在phpdocumentor的類中正確記錄數組屬性?

例:

<?php 
class foo { 
    /** 
    * This holds something important 
    * @var string 
    */ 
    protected $junk; 
    /** 
    * This holds an important array of strings 
    * @var ??????? 
    */ 
    protected $stuff = array(); 
    // ... 
} 
?> 

我無法找到有關陣列性能的PHPDoc的手動什麼。

+3

你有沒有試過'* @var string []'?另請參見:[PHPDoc類型提示對象的數組?](http://stackoverflow.com/q/778564/367456) – hakre 2012-03-03 21:37:57

+0

'@var array' ?? – 2012-03-03 21:42:46

+0

在netbeans中,它似乎接受@var string []。謝謝 – 2012-03-03 21:49:10

回答

2

/** @var array */對於您的protected $stuff是正確的語法。 @var的phpDocumentor手冊頁顯示「數據類型應該是一個有效的PHP類型(int,string,bool等)」,而「array」是這樣一個有效的PHP類型。

一些IDE也開始認識到/** @var ElementType[] */表示「這是一個數組,其元素都是ElementType類型」。該語法將在即將發佈的phpDocumentor版本中提供。

相關問題