Netbeans的PHPDoc的@return

Question

我一直在記錄我的方法在Netbeans的，像這樣：

/** 
* Fetches a list of all the task ids that are dependent on the specified task being finished 
* before they can be marked as available to work on. 
* @param int $taskId - the id of the task we wish to fetch the dependency list for 
* @return Array<int> $dependents - array list of tasks dependent on the specified task 
*          being completed. 
*/ 
public function getDependencyList($taskId) 

現在，如果我的方法（用CNTRL-R）中重命名變量$任務id，然後將文檔自動更新。不幸的是，@return屬性並非如此。有沒有辦法啓用這個或我只是簡單地生成我的文檔？

Answer 1

您正在錯誤地編寫文檔。試想一下，作爲文檔消費者，我知道函數內部的返回值首先被一個名爲$dependents的變量捕獲，對我有什麼價值？

它沒有。我不關心函數是如何編碼的，我只關心它是否返回一個依賴列表，如函數的名稱所示，以及如何訪問該列表的元素（通過將其作爲一個整數數組訪問）文檔中的類型說明）。

對於參數，情況是不同的，因爲可以使用參數名稱來確定參數列表中的哪個位置參數是預期的，但是對於返回值則不存在該考慮因素。