2011-11-14 24 views
2

在函數上使用phpdoc時,我有一個參數總是包含一個類的實例,有什麼方法可以在phpdoc中記錄這個,以便生成的phpdoc鏈接到給定的類?phpDoc,類實例爲@param?

類似於@param MyClass() $var

我無法在文檔中找到任何信息,實際上文檔甚至沒有提及對象(stdClass)類型參數,句點。

回答

5

您需要刪除括號,它應該工作開箱:

@param MyClass $var Parameter takes instance of MyClass 

對此的正式語法是:

@param type [$varname] description 

看一看文檔http://manual.phpdoc.org/HTMLframesConverter/default/(你需要點擊左邊的@param)

+0

完美,謝謝。具有諷刺意味的是,創建用於記錄代碼的軟件的開發人員不會很好地記錄他們的代碼.. :) – Naatan

+2

實際上,他們執行:http://manual.phpdoc.org/HTMLframesConverter/default/並單擊@param – halfdan

+0

我想我一定讀過它太快了,謝謝:) – Naatan