PHP_CodeSnifferで"Tag cannot be grouped with parameter tags in a doc comment"に遭遇した際の対処法

概要

php_codesnifferでのエラー情報は妙に検索に出づらい。
まあ自動整形できるからそりゃ無視していい気がするけども、phpcbfで引っかからなかった上に微妙に対処方法がわかりづらいエラーメッセージなので対処方法を検索するも日本語の情報がなかったため備忘としてここに記載する。

問題のコード

以下のように関数の説明文をなんとなくで書いてるとタイトルのエラー、"Tag cannot be grouped with parameter tags in a doc comment"に遭遇する。

ng.php

<?php
/**
 * ファイルの説明文。エラーが出ない最小構成ってだけなので無視してOK。
 *
 * PHP Version N
 *
 * @category Example
 * @package  Qiita
 * @author   Hayakuchi0 <[e-mail]>
 * @license  MIT Lisence
 * @link     https://qiita.com/Hayakuchi0
 */
/**
 * 関数の説明文。ここが問題。
 *
 * 関数つくったよ
 * 複数行の説明文をかいてるよ
 *
 * @param  string $fuga 引数の説明
 * @param  string $piyo 特に意味のある引数ではない
 * @return int 問題のエラーメッセージが出る行
 */
function hoge($fuga, $piyo)
{
    return 1;
}
?>

原因と対処法

@paramタグを書いたら、ちゃんと下に一行あけないと怒られるので、ちゃんとあけましょう。

ok.php

<?php
/**
 * ファイルの説明文。エラーが出ない最小構成ってだけなので無視してOK。
 *
 * PHP Version N
 *
 * @category Example
 * @package  Qiita
 * @author   Hayakuchi0 <[e-mail]>
 * @license  MIT Lisence
 * @link     https://qiita.com/Hayakuchi0
 */
/**
 * 関数の説明文。ここが問題。
 *
 * 関数つくったよ
 * 複数行の説明文をかいてるよ
 *
 * @param string $fuga 引数の説明
 * @param string $piyo 特に意味のある引数ではない
 * 
 * @return int 問題のエラーメッセージがなくなる
 */
function hoge($fuga, $piyo)
{
    return 1;
}
?>

参考資料