2013-11-22 88 views
1

我安裝了phpDocumentor 2使用梨如phpdoc.org上所述。這樣做時,我編我的意見phpDocumentor 2標籤不工作

/** 
    * Calls class1 
    * @see class2 
    * @access public 
    */ 
class class1 { 

} 

/** 
    * Calls class2 
    * you can {@link class1} 
    */ 
class class2 { 

} 

第一個沒有工作,除非你說@see類2級2,第二個也不會不管工作。它只是打印它看起來像,而不是閱讀大括號作爲行內標籤。所以,我的問題是 - 我在這裏做錯了什麼?有沒有人遇到過類似的事情?我下載了phpDocs 1.x並沒有這個問題,但是如果可能的話,我想要phpDocs 2 ..

謝謝!

回答

3

phpDocumentor 2.x尚未實現1.x中可用的內聯鏈接標記(「{@link}」)。它在TODO列表上。我也建議在這裏使用@see標籤,但顯然你不能這樣做作爲一個內聯標籤。

我希望@see標籤只需要目標類名稱(「@see class2」)就可以正常工作,而不需要描述文本(「@see class2 Class 2」)。我認爲你描述的行爲是一個bug,可以在這裏報告 - https://github.com/phpDocumentor/phpDocumentor2/issues

順便說一句,@access標籤沒有關於類本身的上下文。 public/protected/private的可見性範圍僅適用於類方法和類屬性,而不適用於類本身。此外,在PHP4中,它已被添加到phpDocumentor 1.x中,之前這種可見性範圍完全可用PHP(PHP5中添加)。因此,它不再有用了。即使在1.x中,如果使用PHP5針對爲PHP5編寫的代碼運行,代碼範圍關鍵字將覆蓋任何@access標記所說的內容。我不相信phpDocumentor 2.x甚至困擾實現@access標籤,並且正確如此。

+0

這當然回答我的問題,並沒有在我身上看到。謝謝! – smcjones