dongma0722 2013-12-10 02: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 03: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.

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

报告相同问题?

悬赏问题

  • ¥15 怎么更换移动网络摄像头的通信模块实现公用
  • ¥15 vue但是页面显示的数据为空为什么呀,明明在钩子函数中已经成功赋值(相关搜索:输出数据)
  • ¥15 syri可视化不显示插入缺失
  • ¥30 运行软件卡死查看系统日志分析不出来
  • ¥15 C语言代码改正特征选择算法设计,贝叶斯决策,,设计分类器,远程操作代码修正一下
  • ¥15 String 类valuve指向的问题
  • ¥15 在ros2的iron版本进行编译时遇到如下问题
  • ¥18 vs用setup project打包项目实现安装完立即运行
  • ¥15 孟德尔随机化TwoSampleMR在线提取结局数据,遇到Error in check_reset(override_429)的问题
  • ¥15 ONNX转RKNN遇到问题
手机看
程序员都在用的中文IT技术交流社区

程序员都在用的中文IT技术交流社区

专业的中文 IT 技术社区,与千万技术人共成长

专业的中文 IT 技术社区,与千万技术人共成长

关注【CSDN】视频号,行业资讯、技术分享精彩不断,直播好礼送不停!

关注【CSDN】视频号,行业资讯、技术分享精彩不断,直播好礼送不停!

客服 返回
顶部