使用PHP docblocks @ best标记，是否有最佳做法将布尔值作为整数(即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
*/

这也允许了未来的扩张。如果您的退出代码被更改以提供比“是”或“否”更有用的信息，该怎么办？"no，因为XYZ“可以用1以外的数字表示，而且您的文档仍然是正确的(这意味着函数的实现不需要更改，除非他们想利用新的信息)