php - 是否有针对PHP文档块的PHPCS标准？

是否有PHPCS编码标准来检查文档块中是否存在正确的注释(@param，@return，@throws等)，包括它们之间的适当间距？

最佳答案

尝试运行以下命令，看看它是否产生您想要的:
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

关于php - 是否有针对PHP文档块的PHPCS标准？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/13767550/