Czy istnieje standardowy docptok PHP do PHPPC?

Question

Czy istnieje standard kodowania PHPCS, który sprawdzi, czy odpowiednie adnotacje (@param, @return, @throws itd.) Są obecne w bloku kresek, w tym między nimi jest odpowiedni odstęp?

Answer 1

Spróbuj uruchomić następujące polecenie i zobacz czy to produkuje to, co chcesz:

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

Jeśli tak, można stworzyć swój własny standard, który właśnie obejmuje te wącha, i cokolwiek innego chcesz sprawdzić . Robisz to, tworząc plik ruleset.xml i używając go jako standardu.

Na przykład, można utworzyć plik o nazwie mystandard.xml i zawierać następującą treść:

<?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> 

Następnie można uruchomić tego polecenia Zamiast:

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

Są inne rzeczy, które można zrobić w plik ruleset.xml. Zobacz docs tutaj: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml

Answer 2

W 2017 masz teraz więcej opcji:

• jeden z najlepiej wącha sprawdzić bloków dokumentacji jest TypeHintDeclarationSniff from SlevomatCodingStandard, świetnie współpracuje z PHP 7, PHP 7.1, spadek niewykorzystane dokumenty itp .
• również można skorzystać z innego narzędzia - PHP-CS-Fixer, tam można znaleźć więcej zbrojarzy, które pomogą Ci z bloku dokumentacyjnym, wystarczy wyszukać „dOC”