phpcodesniffer — PHP Code Sniffer не получает файл, класс и функциональные комментарии к документу

Я работаю над внедрением PHPCS в мои скрипты сборки и разрешила все ОШИБКИ и ПРЕДУПРЕЖДЕНИЯ с относительной легкостью (и небольшой помощью SO :)).

Тем не менее, я не могу понять, почему я все еще получаю ОШИБКУ, говоря, что в классе отсутствуют комментарии к файлам, классам и функциям.

----------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 7 LINES
----------------------------------------------------------------------
2 | ERROR | Missing file doc comment
28 | ERROR | Missing class doc comment
45 | ERROR | Missing function doc comment
59 | ERROR | Missing function doc comment
73 | ERROR | Missing function doc comment
88 | ERROR | Missing function doc comment
102 | ERROR | Missing function doc comment
----------------------------------------------------------------------

Вот класс PHP:

<?php
/**
* EndpointHelper File Doc Comment
*
* @category    EndpointHelper
* @package     Helper
* @author      Brian Smith <[email protected]>
* @copyright   Copyright 2015 Company, Inc. All rights reserved.
* @license     GNU General Public License version 2 or later; see LICENSE
* @link        http://arctg.com
*/

/**
* EndpointHelper Class Doc Comment
*
* Endpoint Helper to retrieve application wide
* URLs based on active webinstance.
*
* @category    Class
* @package     EndpointHelper
* @author      Brian Smith <[email protected]>
* @copyright   Copyright 2015 Company, Inc. All rights reserved.
* @license     GNU General Public License version 2 or later; see LICENSE
* @link        http://company.com
*
* @since   1.0.1
*/
class EndpointHelper
{
/**
* Component params object
*
* @var type
* @since   1.0.1
*/
private static $params = false;

/**
* Retrieve Reservation URL based on web instance
*
* @return String
*
* @since   1.0.1
*/
public static function getReservationUrl()
{
$instance = self::getInstanceType();

return self::$params->get($instance . '_reservation_api_url');
}

/**
* Retrieve Rental URL based on web instance
*
* @return String
*
* @since   1.0.1
*/
public static function getRentalUrl()
{
$instance = self::getInstanceType();

return self::$params->get($instance . '_rental_api_url');
}

/**
* Retrieve cache URL based on web instance
*
* @return String
*
* @since   1.0.1
*/
public static function getCacheUrl()
{
$instance = self::getInstanceType();

return self::$params->get($instance . '_data_cache_api_url');
}

/**
* Retrieve Systems Staging File Sync URL based on web
* instance.
*
* @return String
*
* @since   1.0.1
*/
public static function getFileSyncUrl()
{
$instance = self::getInstanceType();

return self::$params->get($instance . '_file_sync');
}

/**
* Private utilty class to retrieve current web instance
*
* @return String
*
* @since   1.0.1
*/
private static function getInstanceType()
{
if (!self::$params)
{
self::$params = JComponentHelper::getParams('com_custom');
}

return self::$params->get('web_instance');
}
}

Спасибо за любую помощь!

4

Решение

Проблема была связана с набором правил, который я использовал от Joomla. Недавно я предпринял еще один шаг, чтобы заставить его работать, и автор Wiki обновил статью, заявив, что вам нужно использовать конкретную версию PHP Docs.

Очистка существующей установки и установка указанной версии решили проблему для меня.

0

Другие решения

Других решений пока нет …

По вопросам рекламы [email protected]