使用 PHp Strom 忽略 Yii2 的“缺少文件文档评论”的任何方法？

Question

如何消除错误，这样我就不必在名称space之前添加文件标签，在名称space

之后添加class标签

namespace backend\controllers;

use common\models\helpers\Frontend\DropdownHelper;
use common\models\Lookup;
use common\models\Partner;
use common\models\PartnerSearch;
use Yii;
use yii\filters\VerbFilter;
use yii\web\Controller;
use yii\web\NotFoundHttpException;
use yii\web\Response;

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

Answer 1

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

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

在您的情况下，您试图忽略页面的文档块和 class，因此您应该在 namespace 之前启动 // phpcs:disable，然后使用 // phpcs:enable 紧跟在 class { 的左大括号之后。

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

<?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.

使用 PHp Strom 忽略 Yii2 的“缺少文件文档评论”的任何方法？

Any way to ignore `Missing file doc comment` Yii2 using PHp Strom?

php

codesniffer