例如,我有以下功能
/**
* Get the latest comment for a task
*
* @param int $task_id
* @return string[] Array of the form ['comment' => '', 'commenter' => '']
*/
function getLatestComment($task_id){
// Default empty comment
$latest_comment = ['comment' => '', 'commenter' => ''];
// Go to database and select comment based on $task_id
...
// If there is a comment, massage as required; assign to $latest_comment
if ($comment_from_db){
...
}
return $latest_comment;
}
我使用的是PhpStorm v2017.2.1
我想使用PHPDoc来记录这个函数,以便进行以下调用,给出了关于返回值的性质的智能感知/提示($ comment,在我下面的代码示例中)
$comment = getLatestComment(1);
我的评论栏中@return的正确形式是什么?
更新 我收到了澄清我的问题的请求。我试图获得正确的语法,以便我的IDE不仅提示函数所需的参数,还提示返回类型,包括属性(或PHP中的字符串键)。
我还添加了一个希望有帮助的截图。