dongma0722 2013-12-10 10:52
浏览 50
已采纳

Netbeans phpdoc @return

I have been documenting my methods in Netbeans like so:

/**
 * 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)

Now if I rename the variable $taskId within the method (with cntrl-r), then the documentation is automatically updated. Unfortunately, this is not the case with the @return property. Is there a way to enable this or am I simply generating my documentation incorrectly?

  • 写回答

1条回答 默认 最新

  • douju2474 2013-12-10 11:11
    关注

    You are writing your documentation incorrectly. Just think, what value does it have to me, as consumer of your documentation, to know that inside your function the return value is first captured in a variable called $dependents?

    It has none. I don't care how the function is coded, I only care about that it returns me a list of dependencies, as the function's name indicates, and how I can access elements of that list (by accessing it as an array of integers, as the type specification states in the documentation).

    For parameters, the case is different, because there the parameter name can be used to determine at which position in the argument list the parameter is expected, but that consideration does not exist for return values.

    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

悬赏问题

  • ¥20 关于#c++#的问题:水果店管理系统
  • ¥30 dbLinq最新版linq sqlite
  • ¥20 对D盘进行分盘之前没有将visual studio2022卸载掉,现在该如何下载回来
  • ¥15 完成虚拟机环境配置,还有安装kettle
  • ¥15 2024年全国大学生数据分析大赛A题:直播带货与电商产品的大数据分析 问题5. 请设计一份优惠券的投放策略,需要考虑优惠券的数量、优惠券的金额、投放时间段和投放商品种类等因素。求具体的python代码
  • ¥15 有人会搭建生鲜配送自营+平台的管理系统吗
  • ¥15 用matlab写代码
  • ¥30 motoradmin系统的多对多配置
  • ¥15 求组态王串口自定义通信配置方法或代码?
  • ¥15 实验 :UML2.0 结构建模