Magento 2 codingStandardsIgnoreFile

7

In der HTML-Datei werden diese Kommentare verwendet

// @codingStandardsIgnoreFile

zB vendor/magento/module-sales/view/frontend/templates/email/items.phtmlZeile 7

Weiß jemand, warum es verwendet wird und kann ich das auch in meinen Erweiterungen verwenden?

magento2 coding-standards Qaisar Satti
quelle

Antworten:

9

Ja, Sie können dies verwenden, wenn Sie PHPCS (Code Sniffer) mit der IDE verwenden.

PHPCS unterstützt Kommentaranweisungen wie:

// @codingStandardsIgnoreFile
// @codingStandardsIgnoreStart
// @codingStandardsIgnoreLine

Sie können PHP_CodeSniffer veranlassen, bestimmte Dateien oder Zeilen in einer Datei mithilfe von Kommentaren zu ignorieren.

Siehe: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage

Oshan
quelle
1
Unter dem folgenden Link wird erklärt, wie PHPCS in PhpStorm eingestellt wird: konfluenz.jetbrains.com/display/PhpStorm/… Und hier ist eine andere URL: github.com/Islandora/islandora/wiki/…
Oshan
9

Ich werde die Antwort von Oshan fortsetzen .

Sie können dasselbe für Ihre Erweiterungen verwenden. Wenn Sie den Code-Sniffer oder die statischen Tests für Ihre Erweiterung ausführen, wird das, was mit markiert @codingStandardsIgnore*ist, ignoriert.
Sie sollten jedoch versuchen, dies so weit wie möglich zu vermeiden, da die Verwendung dieser Anmerkungen nur eine Möglichkeit ist, den Schmutz unter dem Teppich zu verbergen.
Die Tatsache, dass sie im Kern verwendet werden, macht es nicht richtig, sie in Ihren Erweiterungen zu verwenden.

Marius
quelle
1
Vielen Dank für die Erwähnung, dass dies nicht empfohlen wird. Es ist ein Versuch von Magento, Probleme zu verbergen, für deren Lösung sie noch keine Zeit hatten. Als Entwickler sollten Sie nicht nachziehen. Beheben Sie das Problem, von dem es Ihnen erzählt!
Robbie Averill