使用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
*/

这也允许未来扩展。如果您的退出代码被更改以提供比＆＃34;是＆＃34;更多有用的信息，该怎么办？或＆＃34;不＆＃34;？ ＆＃34;不，因为XYZ＆＃34;可以使用1以外的数字表示，并且您的文档仍然是正确的（这意味着函数的实现不需要更改，除非他们想要利用新信息）