SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-16 00:06

技能介绍

用途:为 PHP 项目提供与框架无关的语言级编码规范,在 code-developer 或 quality-reviewer 处理 PHP 文件时调用,适用于 CakePHP、Laravel、Symfony 及纯 PHP 代码库。

主要能力:

  1. PSR-12 合规:文件顶部要求 declare(strict_types=1);,使用 PSR-4 命名空间与按字母排序的 use 导入;类名用 PascalCase,方法、属性与局部变量用 camelCase,常量用 UPPER_SNAKE_CASE;缩进 4 空格,行宽不超过 120 字符,属性与方法、方法与方法之间留空行。
  2. PHPDoc 标准:公共方法需有简短描述、可选长描述,以及 @param、@return、@throws 等必需元素;可选 @see、@deprecated、@todo;属性用 @var 标注,如 @var array<string, mixed>。
  3. 类型提示(PHP 8.2+):所有方法需声明参数与返回类型,支持联合类型(string|int)与可空类型(?User)。
  4. 错误处理:使用具体异常类型(InvalidArgumentException、RuntimeException、LogicException),用 @throws 记录所有抛出的异常,try-catch 中区分具体异常与通用异常并记录日志。
  5. 代码质量检查清单:公共方法均有 PHPDoc、参数有类型提示、声明返回类型、异常有 @throws、应用 PSR-12、无未使用导入、属性有可见性修饰符、不使用 PHP 短标签。

使用方式:可用 PHPStan 做类型检查:vendor/bin/phpstan analyse src tests --level 7;用 PHP-CS-Fixer 自动格式化:vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php。

限制:仅覆盖 PHP 语言级规范,框架特定约定应定义在框架级技能中(如 php-cakephp/framework-conventions)。资料未提供安装命令、收费方式与具体平台信息。