WooCommerce Code Review 用于对照 WooCommerce 编码标准与约定审查代码变更。
用途 该技能适用于在本地审查代码、执行自动化 PR 审查,或检查代码质量时使用,帮助发现不符合 WooCommerce 规范的代码问题。
主要能力 该技能会标记关键违规项,并引用相关技能文件作为依据。
后端 PHP 代码方面,需参考 woocommerce-backend-dev 技能获取详细标准,标记的违规包括:
架构与结构:
- 独立函数:必须使用类方法(file-entities.md)。
- 对 DI 管理的类使用 new:src/ 中的类必须使用 $container->get()(dependency-injection.md)。
- 类位于 src/Internal/ 之外:除非明确为公开,否则默认位置应在 src/Internal/(file-entities.md)。
命名与约定:
- camelCase 命名:方法、变量、钩子必须使用 snake_case(code-entities.md)。
- Yoda 条件违规:必须遵循 WordPress 编码标准(coding-conventions.md)。
文档:
- 缺少 @since 注解:公共/受保护方法及钩子必须包含(code-entities.md)。
- 缺少 docblock:所有钩子和方法必须包含(code-entities.md)。
- 冗长的 docblock:应保持简洁,理想情况为一行(code-entities.md)。
数据完整性:
- 缺少验证:在删除或修改前必须验证状态(data-integrity.md)。
测试:
- 在测试中使用 $instance:必须使用 $sut 变量名(unit-tests.md)。
- 缺少 @testdox:测试方法 docblock 中必须包含(unit-tests.md)。
- 测试文件命名:必须遵循 includes/ 与 src/ 的命名约定(unit-tests.md)。
UI 文案方面,需参考 woocommerce-copy-guidelines 技能,标记:
- UI 中使用标题式大小写:必须使用句子式大小写(sentence-case.md)。
- 错误示例:"Save Changes"、"Order Details"、"Payment Options"。
- 正确示例:"Save changes"、"Order details"、"Payment options"。
- 例外:专有名词(WooPayments)、缩写(API)、品牌名称。
使用方式 审查方法包括:扫描上述关键违规项;标记问题时引用具体技能文件;提供技能文档中的正确示例;将相关问题分组以便清晰呈现;保持建设性,在相关时解释标准存在的原因。
输出格式 对于发现的每个违规项,输出: [问题类型]:[具体问题] 位置:[文件路径与行号] 标准:[相关技能文件链接] 修复:[简要说明或示例]
适用场景 适用于本地代码审查、自动化 PR 审查以及代码质量检查。
限制与说明 所有详细标准位于 woocommerce-backend-dev、woocommerce-dev-cycle 和 woocommerce-copy-guidelines 技能中,需查阅这些技能获取完整上下文和示例。如有疑问,请参考上述链接的具体技能文档。