015 — PhpStorm 元数据和属性

PhpStorm 元数据

PhpStorm 元数据 帮助 IDE 在常规类型和 PHPDoc 标签无法提供帮助的情况下更好地理解代码。

我们对元数据使用以下编码风格。

元数据位置

• 元数据应放置在 /.phpstorm.meta.php 目录中。
• 配置应拆分为多个文件。每个文件应以其配置的类命名。

NOTE

PhpStorm 目前还不支持子目录。

常量

所有常量字典应命名为 {类完全限定名}::{组名}。组名应简短并使用大写字母。使用下划线作为单词分隔符，例如 \Yiisoft\Http\Status::STATUSES。示例：

expectedReturnValues(
  \Psr\Http\Message\RequestInterface::getMethod(),
  argumentsSet('\Yiisoft\Http\Method::METHODS'),
);

registerArgumentsSet(
  '\Yiisoft\Http\Method::METHODS',
  \Yiisoft\Http\Method::GET,
  \Yiisoft\Http\Method::POST,
  \Yiisoft\Http\Method::PUT,
  \Yiisoft\Http\Method::DELETE,
  \Yiisoft\Http\Method::PATCH,
  \Yiisoft\Http\Method::HEAD,
  \Yiisoft\Http\Method::OPTIONS,
);

PhpStorm 属性

PhpStorm 属性 可以在代码中使用，但必须将 jetbrains/phpstorm-attributes 包添加为开发依赖：

composer require --dev jetbrains/phpstorm-attributes

与 ComposerRequireChecker 一起使用

当在同一个包中也使用 ComposerRequireChecker 时，将涉及的属性类名添加到配置的白名单中。例如：

{
    "symbol-whitelist": [
        "JetBrains\\PhpStorm\\ExpectedValues",
        "JetBrains\\PhpStorm\\Pure"
    ]
}