phpDocumentor 如何指定副作用？

Question

我正在尝试正确注释我的代码，我通常不会从函数中回显任何内容，通常我只是返回数据，然后在需要时回显返回值。今天我编写了一个函数，该函数将仅在 View 文件中频繁使用，所以我想为什么不直接从函数内部回显，然后在需要时调用它，避免在任何地方输入回显。

我想知道是否有任何方法可以在 phpDoc 注释中表明该函数将回显一个字符串。@sideEffect 输出或 UpdateDb 或 SendToQueue 之类的东西？

/**
 * Echo error class
 * @param array $fields
 * @param string $field
 * @return void
 * @sideEffect output
 */
public static function getFailedClass($fields, $field)
{
    if (isset($fields[$field])) {
        echo 'failedValidation';
    }
}

所以可以像这样在 View 中使用:

<textarea name="data" class="<?php Lib\Validation::getFailedClass($fields, 'data'); ?>"></textarea>

Answer 1

不，没有指示此类行为的文档标签。充其量，人们会在描述中强调这种行为发生在函数中。

您可能会考虑的替代方法是让函数返回而不是回显，并使用 <?=您 View 中的短回显标签。这样，您就可以避免编写有副作用的函数(通常被认为是一种反模式)，同时仍然可以避免输入 echo。在每次使用该功能时。两全其美:-)