有关文档PHP发布数据和返回JSON的注释

Question

我实际上有两个问题：

1. 对于某些功能，我要向他们发布表单，我可以在评论中以@params形式提及它们@params ？

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

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

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

Answer 1

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

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

@return string Text here describing what is being returned

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