Для чего используется тег пакета PHPDoc? - PullRequest
0 голосов
/ 28 октября 2018

Я создал класс PHP в PhpStorm и позволил IDE автоматически генерировать DocBlock для этого класса.Он включал тег пакета, который точно соответствовал пространству имен файла следующим образом:

<?php
namespace frontend\controllers;

/**
 * Class MethodController
 * @package frontend\controllers
 */
class MethodController extends BaseRestController 
{
}

В настоящее время я не хочу генерировать вывод PHPDocumentor, но я, возможно, захочу в какой-то момент, поэтому я бы хотелпонять, как используется @package.Что меня удивляет, так это сообщение, которое PHP_CodeSniffer предоставил для этого тега:

[phpcs] Имя пакета "frontend \ controllers" недопустимо;вместо этого рассмотрим "Frontendcontrollers"

Нужно ли создавать какое-то оглавление для удовлетворения PHP_CodeSniffer?

Еще один недоумение вызывает эта цитата с сайта PHPDoc :

Если по всей плате логические и функциональные подразделения равны, НЕ РЕКОМЕНДУЕТСЯ использовать тег @package, чтобы избежать накладных расходов на обслуживание.

ЕслиЯ правильно понимаю, нет смысла делать пакет точно равным пространству имен.Почему PhpStorm предоставил этот тег?

...