有时,有必要/方便地引入从不返回控制权的 PHP 函数或方法 - 也就是说,总是调用 exit() 或引发异常。例如,我们需要一些共享代码,它将给定的异常实例转换为其他类的异常实例并重新抛出它 - 但永远不会将控制权返回给调用者。
如何注释这些函数/方法,特别是对于 PhpStorm?它不仅仅是 @return void ,它还应该提示控件永远不会返回,因此 IDE 会正确警告调用后出现的死代码。
/** @how-to-annotate-return? */
function outputAndExit($message) {
echo $message . "\nExiting\n";
exit();
}
/** @how-to-annotate-return? */
function convertException(\Exception $e) {
throw $e instance \LogicException ? new \RuntimeException : $e;
}
// ... so that following code will generate dead code warning:
try {
// some code which may throw exception
$m = 'happy';
outputAndExit($m);
$m = 'sad'; // dead code!!!
} catch (\Exception $e) { …Run Code Online (Sandbox Code Playgroud)