如何寫PHPDoc的在函數聲明沒有具體指定的參數

Question

如果我有一個參數，我訪問這樣的

$msg = Input.get("message");

難道我用的@param標記過，或者是隻對參數像

public function stageFiles($user, $project)

此外，什麼是當您返回一個JSON對象來記錄的正確方法。

謝謝。

Answer 1

JSON不是公認的PHP數據類型，因此您應該使用字符串或stdClass，具體取決於JMS由該$ msg變量表示的實際方式。

如果你想要進行歸檔，以$味精數據類型，有一個非正式的語法有些IDE會認識到：

/** @var string $msg a JSON string */ 
$msg = Input . get("message"); 

再次，這是一些的IDE會認識到一個非正式的語法。我覺得有些IDE查找的數據類型，而不是變量名後前來：

/** @var $msg string a JSON string */ 

也不被認爲是「標準」的用法，但第一個提出了成爲PHP-圖的PSR-5草案規範。我建議使用它，如果你的IDE更喜歡它，只使用第二種語法。