评论对文档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应该描述有问题的函数的实际参数和返回值。见例如（主要是）常规的draft PHP-FIG recommendation。

如果你返回一个JSON字符串倒不如将其文档

@return string Text here describing what is being returned

以来就PHP而言它只是一个字符串。