2014-03-06 31 views
3

我有一個很大的代碼庫,我正在嘗試生成分層文檔。該項目不使用命名空間,而是使用@package。在PhpDocumentor 2中使用@package而不是名稱空間

我只是試圖生成文檔如從下面的文件的測試與phpDocumentor2:

<?php 
/** 
* This is a file 
* @package JustAn\Example 
**/ 

/** 
* Something class 
**/ 
class Something{ 
    function try_this(){ 

    } 
} 

雖然根據該文檔@package JustAn \實施例應該是命名空間JustAn \實施例的等價物,我發現這個不就是這樣。

當我使用的命名空間所產生的文件是這樣的:

namespace version

當我使用@package符號的結果看起來是這樣的(儘管它承認包符號 - 這是顯示在類的全部詳細信息頁):

package notation version

我正在尋找一種方式來獲得分級結果,而無需重寫代碼使用「REA l'命名空間。

+0

目前似乎有@package的問題。請參閱https://github.com/phpDocumentor/phpDocumentor2/issues/1133 – toxalot

+0

這似乎是無關的,因爲@package標記已註冊,它只是不會導致相同的hiearchical列表。我爲它創建了一個問題:https://github.com/phpDocumentor/phpDocumentor2/issues/1155 – Aron

回答

3

問題是默認的「乾淨」模板不支持此功能。其他模板(如「響應」)例如。您可以使用--template =「responsive」標誌更改所使用的默認模板。

+0

這不能解決我遇到的問題。你真的得到了這個工作,或者你只是在問題線程中通過mvriel的回答嗎? – toxalot

+0

這些模板工作:「響應」,「響應枝」工作。 – Aron

+0

我希望這可以在未來由phpdoc團隊添加。同時,我只是確認「響應式」或「響應式樹枝」適合我,雖然它看起來不如「乾淨」。另一個想法,我們可能應該使用命名空間! – windmaomao

0

我看到你有文件中的包標記 docblock,但不是 docblock。如果您將其添加到您的課堂docblock,我認爲它應該工作。

+0

剛剛嘗試在類級別上設置它 - 結果是一樣的:列表中沒有名稱空間層次結構。 – Aron

相關問題