PHP是否有用於描述無極功能的docblock返回

我只是寫這樣的函數PHP是否有用於描述無極功能的docblock返回

/** 
    * Send an asynchronous GET request 
    * 
    * @param string $url 
    * @param array $options 
    * 
    * @return \React\Promise\ExtendedPromiseInterface 
    */ 
    public function getAsync($url, array $options = []);

但做的docblock的時候，我意識到，@return \React\Promise\ExtendedPromiseInterface很普通，沒有真正幫助客戶瞭解什麼約定在拒絕或履行的情況下，預計會有退貨。

是否有一些建立的約定用於記錄作爲此函數結果的預期值或異常，以便客戶端可以通過僅查看接口鏈接此函數？

來源

2016-06-20 Eugene

由於沒有發現任何東西，我最終使這件事

/** 
    * Send an asynchronous GET request 
    * 
    * @param string $url 
    * @param array $options 
    * 
    * @return \React\Promise\ExtendedPromiseInterface 
    * 
    * @promise.resolve \MyApp\Interfaces\ResponseInterface 
    * @promise.reject \MyApp\Exceptions\RequestException 
    */ 
    public function getAsync($url, array $options = []);

來源

2016-06-23 14:09:33 Eugene

例外情況您可以添加：

/** 
* @throws customException if the bad thing happens 
*/

你可以添加儘可能多的這些，你喜歡了。在@return之後，您可以在之前添加一個類型，並簡要描述它之後的內容。

來源

2016-06-20 15:32:00

謝謝您的回答，但我不認爲這會是一個很好的解決方案，因爲它可能有同樣的功能都異常和承諾。 – Eugene

PHP是否有用於描述無極功能的docblock返回

回答

相關問題