PHP Lang
  1. PHP Lang
  3. Есть ли стандарт PHPCS, предназначенный для PHP docblocks?
Intereting Posts
Неустранимая ошибка: вызов функции-члена prepare () для не-объекта в AMQPRuntimeException: ошибка чтения данных. Получено 0 вместо ожидаемых 7 байт Как проверить, был ли DomDocument изменен простым и быстрым сравнением? FOSUserBundle AJAX Вход с Symfony2 (маршрутизация) Использование JQuery Ajax с PHP Будут ли PHP открываться после 301 переадресации? Получение элементов DOM по имени класса Объединение двух SQL-запросов PDO Создание сервиса с помощью Symfony2 Как хранить последовательные данные в mysql разбиение на страницы в simpledb Функция «Ограничить слова», затем показывать текст слева Есть ли функция для извлечения «столбца» из массива в PHP? Загрузка файла PHP с использованием данных POST через jQuery AJAX Laravel, неспособный copyDirectory или moveDirectory

Есть ли стандарт PHPCS, предназначенный для PHP docblocks?

Есть ли стандарт кодирования PHPCS, который бы проверял, что в @param правильные аннотации ( @param , @return , @throws и т. Д.), Включая правильный интервал между ними?

Solutions Collecting From Web of "Есть ли стандарт PHPCS, предназначенный для PHP docblocks?"

Попробуйте запустить следующую команду и посмотреть, создает ли она то, что вы хотите:

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

В 2017 году у вас теперь есть больше возможностей:

  • одним из лучших нюков для проверки докблоков является TypeHintDeclarationSniff от SlevomatCodingStandard , отлично работает с PHP 7, PHP 7.1, удаляет неиспользуемые документы и т. д.
  • также вы можете использовать другой инструмент – PHP-CS-Fixer , там вы можете найти больше фиксаторов, которые помогут вам с docblock, просто выполните поиск «doc»,