使用PHPDoc提供@return可能的值和含义

Question

我知道@return注释可以在函数返回某些内容时使用，例如：

@return int The count of created elements

如果函数返回例如状态码怎么办？我希望我可以在注释中记录所有状态代码的含义。能做到吗？

当然可以，但是我怀疑PHPDoc实际上会将这些信息视为潜在值，而不是纯文本。

/**
 * @ return int The status code
                                0 => Success
                                1 => Connection failure
                                2 => Bad parameters
*/