Любой способ игнорировать `Отсутствует комментарий к файлу документа` Yii2 с помощью PHp Strom?

Question

Как я могу удалить ошибку, чтобы мне не нужно было добавлять тег файла перед пространством имен и тег класса после пространства имен

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.

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