是否有針對PHP docblocks的PHPCS標準？

是否有PHPCS編碼標準可以檢查文檔塊中是否存在正確的註釋（@param,@return,@throws等），包括它們之間的適當間距？是否有針對PHP docblocks的PHPCS標準？

2012-12-07 Benjamin

嘗試運行以下命令，看看它是否產生你想要什麼：

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.xml

來源

2012-12-08 00:54:37

這個答案是從2012年開始的。它仍然是正確的。但是我今天會補充說，你也可以使用Generic.Commenting.DocComment嗅探。這些嗅覺行爲有點不同，所以選擇最適合你的風格。 – mkasberg

在2017年你現在更多的選擇：

的最好嗅着檢查文檔塊是TypeHintDeclarationSniff from SlevomatCodingStandard之一，PHP 7，PHP 7.1的偉大工程，刪除未使用的文檔等。
也可以使用另一種工具 - PHP-CS-Fixer，那裏你可以找到更多的固定器，這將有助於你的docblock，只要搜索「DOC」

來源

2017-05-01 16:54:38

是否有針對PHP docblocks的PHPCS標準？

回答

相關問題