提问人:Schparky 提问时间:10/28/2018 最后编辑:LazyOneSchparky 更新时间:10/28/2018 访问量:1544
PHPDoc 包标签是做什么用的?
What is the PHPDoc package tag used for?
问:
我在 PhpStorm 中创建了一个 PHP 类,并允许 IDE 自动生成该类的 DocBlock。它包含一个与文件命名空间完全匹配的包标记,如下所示:
<?php
namespace frontend\controllers;
/**
* Class MethodController
* @package frontend\controllers
*/
class MethodController extends BaseRestController
{
}
我目前不关心生成 PHPDocumentor 输出,但我可能想在某个时候生成,所以我想了解如何使用。令我惊讶的是PHP_CodeSniffer为这个标签提供的消息:@package
[phpcs]包名称“frontend\controllers”无效;请考虑“前端控制器”
我是否需要创建某种目录来满足PHP_CodeSniffer?
另一个令人困惑的转折是 PHPDoc 网站上的这句话:
如果逻辑和功能细分全面相等,则不建议使用 @package 标签,以防止维护开销。
如果我理解正确,那么使包完全等于命名空间没有任何好处。为什么 PhpStorm 提供这个标签?
答: 暂无答案
评论
Settings / Preferences | Editor | File and Code Templates
@package
#if (${NAMESPACE}) * @package ${NAMESPACE} #end
Settings/Preferences | Editor | File and Code Templates