php - 文档注释 PHP 发布数据并返回 JSON

Question

我实际上有两个问题：

1. 对于我向他们发布表格的某些功能，我可以@params在评论中提及它们还是什么：

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

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

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

Answer 1

你可以在评论中写任何你喜欢的东西。也就是说，它不是常规用途 -@param应该@return描述相关函数的实际参数和返回值。参见例如PHP-FIG 建议草案，了解（大部分）常规内容。

如果您要返回 JSON 字符串，最好将其记录为

@return string Text here describing what is being returned

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