php - PHP docblocks @return タグを使用してブール値を整数 (つまり 1 または 0) として返すためのベスト プラクティスはありますか?

Question

これを行うためのよりクリーンな方法はありますか？

/**
 * Will return either a 1 or 0
 * 
 * @return int|boolean
 */
public function getExitCode()
{
    return $this->exitCode;
}

ブール値としてキャストされた値は返されず、整数としてキャストされます。

Answer 1

を返す場合int、ドキュメントには int を返すと記載する必要があります。ただし、次のように説明できます。

/**
* @return int 0 on success, non-zero indicates failure
*/

これにより、将来の拡張も可能になります。「はい」または「いいえ」よりも有用な情報を提供するように終了コードが変更された場合はどうなりますか? 「いいえ、XYZ」は 以外の数値で表すことができるため1、ドキュメントは引き続き正しいです (つまり、新しい情報を利用したい場合を除き、関数の実装を変更する必要はありません)。