क्या कोई PHPCS मानक लक्ष्यीकरण PHP docblocks है?

Question

क्या कोई PHPCS कोडिंग मानक है जो उचित टिप्पणियां (@param, @return, @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

यदि ऐसा है, आप अपने खुद के मानक है कि सिर्फ उन sniffs शामिल बना सकते हैं, और कुछ और आप जाँच करना चाहते हैं । आप इसे 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

Answer 2

2017 में आपके पास अब अधिक विकल्प: यहाँ डॉक्स देखें

• की सबसे अच्छा docblocks जाँच करने के लिए sniffs TypeHintDeclarationSniff from SlevomatCodingStandard है एक, पीएचपी 7, पीएचपी 7.1 के साथ महान काम करता है, अप्रयुक्त डॉक्स आदि ड्रॉप ।
• भी आप एक और उपकरण का उपयोग कर सकते - PHP-CS-Fixer, वहाँ आप अधिक फिक्सरों, docblock साथ आप में मदद मिलेगी पा सकते हैं, बस खोज "डॉक"