PHPDocにおける @throws の使い方 2021 ver. - FRTKL

PHPDocには @throws という表記でそのメソッドが投げ得る例外を文書化することができます。 今回はその個人的使い方の方針をまとめます。2021年バージョンです。 ※ 一度社内に展開してガラッと見解が変わったのでそれを反映させてます そもそも、PHPDocの @throws とは @throwsタグは、メソッドが特定のエラー/例外を投げる可能性があることを示すために使用できます /** * データベースに接続する * * @param string $dsn 接続情報 * @return bool 接続可否 * @throws RecoverbleDbException 接続に一時的に失敗した場合にthrowされる */ function connect($dsn) { // something... } https://zonuexe.github.io/phpDocumento