PHPDoc软件包标记用于什么用途?

时间:2018-10-27 23:18:52

标签: php namespaces phpstorm phpdoc

我在PhpStorm中创建了一个PHP类,并允许IDE自动为该类生成DocBlock。它包含一个与文件名称空间完全匹配的包标记,如下所示:

<?php
namespace frontend\controllers;

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

我目前不关心生成PHPDocumentor输出,但是我可能想在某个时候使用,因此我想了解如何使用@package。令我惊讶的是PHP_CodeSniffer为此标签提供的消息:

  

[phpcs]软件包名称“ frontend \ controllers”无效;可以考虑使用“前端控制器”

我需要创建某种目录来满足PHP_CodeSniffer吗?

PHPDoc website中的这句话是另一个令人困惑的转折:

  

如果总体上逻辑和功能两个部分相等,是否不建议使用@package标记,以防止维护开销。

如果我正确理解这一点,则使包与名称空间完全相等没有任何好处。为什么PhpStorm提供此标签?

0 个答案:

没有答案