PHP 7 文档 block 和函数返回类型？

Question

如果我声明我的函数返回类型，我是否必须在 php 7 中创建文档块？

例如，这样做是否足够:

public function findByLogin(string $login): User
{
    return User::where(User::COL_LOGIN, $login)->first();
}

或者我应该这样做:

/**
 * Find a user by its login.
 *
 * @param string $login
 * @return User
 */
public function findByLogin(string $login): User
{
    return User::where(User::COL_LOGIN, $login)->first();
}

感觉像双重文档。

Answer 1

您不需要将 PHPDocs 添加到您的代码中 - 返回类型声明很好。

添加 PHPDoc 的唯一原因是定义更多信息/更具体的类型。

在此处查看此示例:

/**
 * @return string[] An array of strings
 */
public function findByLogin(): array
{
    return ['foo', 'bar'];
}

因此，如果您对返回类型满意，请随时跳过 PHPDoc。如果你想提供更多关于参数/返回类型的标准化信息:添加一个额外的 PHPDoc。

PHPStorm 等工具有助于保持参数、返回类型和 PHPDoc 同步。如果两者不匹配，它们将显示警告。