是否有针对PHP文档块的PHPCS标准？
是否有针对PHP文档块的PHPCS标准？
提问于 2012-12-08 00:58:04
是否有一个PHPCS编码标准可以检查正确的注释(@param、@return、@throws等)是否存在于文档块中，包括它们之间的适当间距？
回答 1
Stack Overflow用户
回答已采纳
发布于 2012-12-08 08:54:38
尝试运行以下命令，看看它是否会产生您想要的结果：
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
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/13767550
复制相关文章
相似问题