评论文档 PHP post 数据并返回 JSON

Question

其实我有两个问题：

1. 对于某些功能，我正在向他们发布表格，我可以在评论中将它们称为 @params 或者什么：

   /* some descriptions 
    *
    * @param string userName
    */
   
   
   
   public function add(){ 
              $userName = $_POST['user']
           ......
   }
   

2. 从某些函数我return将数据作为JSON，如何提及JSON作为return类型和格式：

    /* some descriptions 
     *
     * @return JSON [{id, name,...}]
     */
   

Answer 1

您可以在评论中写任何您喜欢的内容。也就是说，这不是常规用法 - @param 和 @return 应该描述相关函数的实际参数和 return 值。参见例如draft PHP-FIG recommendation 表示（大部分）常规内容。

如果您return输入一个JSON字符串，最好将其记录为

@return string Text here describing what is being returned

因为就 PHP 而言，它只是另一个字符串。