使用PHp Strom可以忽略`Missing file doc comment` Yii2吗?

时间:2019-02-01 09:50:28

标签: php codesniffer

如何消除错误,这样我就不必在名称空间之后添加文件标签,而在名称空间之后添加类标签

<button class="element">1</button>
<button class="element">2</button>
<button class="element">3</button>
<button class="element">4</button>

phpStorm中缺少文件标签和类标签错误。

1 个答案:

答案 0 :(得分:1)

您的代码的某些部分可能不符合您的编码标准。您可以通过以下方式忽略文件部分

$xmlPackage = new XMLPackage;
// phpcs:disable
$xmlPackage['error_code'] = get_default_error_code_value();
$xmlPackage->send();
// phpcs:enable

在您的情况下,您尝试忽略页面和类的doc块,因此应在// phpcs:disable之前启动namespace,然后紧接着在之后使用// phpcs:enable关闭它{类的左括号。

我正在添加示例代码,以使用我自己的代码忽略下面文件和类的docs块,因为您从未添加实际代码,而是图像

<?php
// phpcs:disable
namespace frontend\controllers;

use Yii;
use yii\filters\AccessControl;
use yii\filters\VerbFilter;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\web\Response;

/**
 * ApiKeysController implements the CRUD actions for ApiKeys model.
 */
class ApiKeysController extends Controller
{
    // phpcs:enable

}

注意:在PHP_CodeSniffer version 3.2.0之前,请使用// @codingStandardsIgnoreStart 代替// phpcs:disable,并使用// @codingStandardsIgnoreEnd代替 // phpcs:enable@codingStandards语法已弃用,并将在 PHP_CodeSniffer version 4.0