php - PHPドックブロックを対象としたPHPCS標準はありますか？

Question

@param適切な注釈（ 、、、@returnなど）がドックブロックに存在することをチェックするPHPCSコーディング標準はあり@throwsますか？それらの間の適切な間隔も含まれますか？

Answer 1

次のコマンドを実行して、必要なものが生成されるかどうかを確認してください。

phpcs /path/to/code --standard=Squiz --sniffs=Squiz.Commenting.FunctionComment,Squiz.Commenting.FunctionCommentThrowTag,Squiz.Commenting.ClassComment,Squiz.Commenting.FileComment,Squiz.Commenting.VariableComment

もしそうなら、それらのスニフとチェックしたいものだけを含む独自の標準を作成できます. ruleset.xmlこれを行うには、ファイルを作成し、それを標準として使用します。

たとえばmystandard.xml、次の内容を含むファイルを作成できます。

<?xml version="1.0"?>
<ruleset name="MyStandard">
  <description>My custom coding standard.</description>
  <rule ref="Squiz.Commenting.FunctionComment" />
  <rule ref="Squiz.Commenting.FunctionCommentThrowTag" />
  <rule ref="Squiz.Commenting.ClassComment" />
  <rule ref="Squiz.Commenting.FileComment" />
  <rule ref="Squiz.Commenting.VariableComment" />
</ruleset>

次に、代わりに次のコマンドを実行できます。

phpcs /path/to/code --standard=/path/to/mystandard.xml

ファイルでできることは他にもありruleset.xmlます。こちらのドキュメントを参照してください: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset