#php_codesniffer

コード上、どうしてもこの範囲だけ PHP_CodeSniffer のルールを無視させたい範囲がある場合（こういうケースは作ってはいけないと思いますが）、何かいい方法はないものかと探していていたら、案の定解決方法が存在しました。

コメントアウトで制御する方法です。

こんなコードを書いた場合、PSR-2 のルールを有効にしていると「 use の次行は一行空けなさい」と怒られます。

use Acme\Hoge; class Fuga { ~ anything ~ }

こんなのは修正すべきですが、今回はこれを無視するようにしてみる。

// @codingStandardsIgnoreStart use Acme\Hoge; class Fuga { // @codingStandardsIgnoreEnd ~ anything ~ }

こいつで無視されました。

使っちゃいかんよ。

参考

php - How can I suppress PHPCS warnings using comments? - Stack Overflow

PHP_CodeSnifferを使ってWordPressのプラグインやテーマがコーディングスタンダードに準拠しているかチェックする | firegoby.

こちらの記事を参考にPEARのコーディング仕様チェックツール「PHP_CodeSniffer」を試してみました。

やはり、上記記事の作者同様、私も自身作のプラグインをチェックしてみようと思います。

ますはこのツールのインストールです。

インストール・・・というかそもそも、このツールはコマンドラインで動作するツールなので SSH等でサーバーにアクセス出来ることが前提となります。

また、pearで「PHP_Sniffer」をインストールし、動かす必要があるのでそういう環境が無い方は注意してください。

>> pear install PHP_CodeSniffer Unknown remote channel:…