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

Question

Как я могу исправить ошибку, поэтому мне не нужно добавлять тег файла перед пространством имен и тег класса для пространства имен после Здесь я добавил, как это https://s tackru.com/images/3c3c72c63300bf240c9549134b754e0432d48eb0.png

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 ,