有什么方法可以使用 PHpStorm 忽略“缺少文件文档注释”Yii2？

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 块，因此您应该在 namespace 之前启动 // phpcs:disable，然后在类的左大括号之后使用 // phpcs:enable 关闭它{。

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

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