Question

我正在努力将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 <brian.smith@company.com>
 * @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 <brian.smith@company.com>
 * @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');
    }
}

感谢您的帮助!!

Answer 1

这个问题与我在Joomla使用的规则集有关。我最近再次尝试将其付诸实施，Wiki的作者更新了文章，说明您需要使用特定版本的PHP文档。

清除现有安装并安装列出的版本为我解决了这个问题。

PHP代码嗅探器没有提取文件，类和功能文档注释

1 个答案: