PHPDoc：@return void 必要吗？

Question

是否真的有必要做这样的事情：

/**
 * ...
 * 
 * @return void
 */

我有很多没有返回值的方法，并且在注释中添加这样的内容似乎真的很多余。忽略它会被认为是不好的形式吗？

Answer 1

如果文档中的内容很清楚，则将其保留，但这并不是绝对必要的。这完全是一个主观决定。

就我个人而言，我会忽略它。

编辑
我纠正了。经过一番谷歌搜索后，维基百科页面显示：

@return [类型描述] 此标记不应该用于使用 void 返回类型定义的构造函数或方法。

phpdoc.org 网站说：

@return 数据类型描述
@return datatype1|datatype2 说明

@return 标签用于记录函数或方法的返回值。 @returns 是 @return 的别名，用于支持其他自动文档生成器的标签格式

数据类型应该是有效的 PHP 类型（int、string、bool 等）、返回对象类型的类名，或者只是“混合”。如果您想显式显示多种可能的返回类型，请以竖线分隔（不带空格）列出它们（例如“@return int|string”）。如果类名用作@return 标记中的数据类型，phpDocumentor 将自动创建指向该类文档的链接。此外，如果函数返回多个可能的值，请使用 | 分隔它们。字符，phpDocumentor 将解析出返回值中的任何类名。 phpDocumentor 将显示未修改的可选描述。

Sooo...基于此，我会说忽略空白。至少它是非标准的。

Answer 2

根据 phpDocumentor，@return void 是有效的：

http://www.phpdoc .org/docs/latest/guides/types.html#keywords

...
该类型通常仅在定义返回类型时使用
方法或函数。基本定义是元素
此类型指示不包含值，用户应该
不依赖任何检索到的值。

例如：

<前><代码> /**
* @返回无效
*/
函数输出Hello()
{
回显“你好世界”；
}

在上面的例子中没有指定 return 语句，因此是
返回值未确定。

资料来源： http://www.phpdoc.org/docs/latest /for-users/phpdoc/types.html (存档页面）。

Answer 3

由于我最近学到的一些东西，我必须编辑我的答案。

使用 @return void 代替 @return null 具有非常特殊的含义，请考虑以下两个 PHP 代码示例。

<?php

/**
 * @return void
 */
function return_never() {
    echo "foo";
}

/**
 * @return null|string
 */
function return_sometimes() {
    if ($this->condition()) {
        return "foo";
    }
}

在第一个示例中，PHP 实际上将返回 NULL，因为 PHP 始终返回 NULL。但返回的值对调用者来说没有用，因为它没有说明该函数做了什么。 IDE 可以使用 @return void 的记录信息来指示开发人员使用了无用的返回值。

<?php

$foo1 = return_never();

$foo2 = return_sometimes();

第一个调用是毫无意义的，因为变量将始终包含 NULL，第二个调用实际上可能包含某些内容。如果我们将函数调用放入条件中，这会变得更加有趣。

<?php

if (($foo1 = return_never())) {
    // Dead code
    var_dump($foo1);
}

if (($foo2 = return_sometimes())) {
    var_dump($foo2);
}

正如您所看到的，@return void 有它的用例，如果适用的话应该使用。

另请注意，它将成为即将推出的 PHP PSR-5 标准的一部分。^[1]

[1] http://www.php-fig.org/psr/

Answer 4

从 php 7.1 开始， void 是有效的返回类型，并且可以在函数上强制执行。

我总是将其添加到文档块中。

编写它的另一个好处是，将 void 方法与可能返回任何内容但由于疏忽而在文档块上没有 @return 条目的方法区分开来。

Answer 5

以下是我对 PhpDocumentor 注释的理解和使用：

<?php

/**
 * This method always returns string.
 * @return string
 */
public function useCase1()
{
    return 'foo';
}

/**
 * This method returns 2 data types so list them both using pipeline separator.
 * @return string|false
 */
public function useCase2()
{
    if ($this->foo === 1) {
        return 'foo';
    }
    return false;
}

/**
 * This method performs some operation and does not return anything so no return
 * annotation is needed.
 */
public function useCase3()
{
    $this->doOperation();
    $this->doAnotherOperation();
}

/**
 * If condition passes method returns void. If condition does not pass it returns
 * nothing so I think that specifying the return annotation with void is in space. :)
 * @return void
 */
public function useCase4()
{
    if ($this->foo === 1) {
        $this->doOperation();
        return;
    }
    $this->doAnotherOperation();
}

Answer 6

就我个人而言，我认为这里缺少的一件大事是记录函数返回结果非常重要。目前标准没有任何关于从不返回的函数的文档......因此 return void 是表示该函数确实返回的方式。

考虑这个代码块

<?php

/**
 * @return void
 */
function return_void() {
    echo "foo";
}

/**
 * @return null|string
 */
function return_sometimes() {
    if ($this->condition()) {
        return "foo";
    }
}

/**
* This function actually doesnt return at all - it kills the script
**/
function noreturn() {
     //do somthing then
     die(); //or exit()
}

显然，使用 @return 至少表明该函数确实返回