有關文檔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而言，它只是另一個字符串。