woocommerce-code-review

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

WooCommerce Code Review

WooCommerce代码审查

Review code changes against WooCommerce coding standards and conventions.

检查代码变更是否符合WooCommerce编码标准和规范。

Critical Violations to Flag

需要标记的严重违规项

Backend PHP Code

后端PHP代码

Consult the

woocommerce-backend-dev

skill for detailed standards. Using these standards as guidance, flag these violations and other similar ones:

Architecture & Structure:

Standalone functions - Must use class methods (file-entities.md)
Using
new
for DI-managed classes - Classes in
```
src/
```
must use
```
$container->get()
```
(dependency-injection.md)
Classes outside
src/Internal/
- Default location unless explicitly public (file-entities.md)

Naming & Conventions:

camelCase naming - Must use snake_case for methods/variables/hooks (code-entities.md)
Yoda condition violations - Must follow WordPress Coding Standards (coding-conventions.md)

Documentation:

Missing
@since
annotations - Required for public/protected methods and hooks (code-entities.md)
Missing docblocks - Required for all hooks and methods (code-entities.md)
Verbose docblocks - Keep concise, one line is ideal (code-entities.md)

Data Integrity:

Missing validation - Must verify state before deletion/modification (data-integrity.md)

Testing:

Using
$instance
in tests - Must use
```
$sut
```
variable name (unit-tests.md)
Missing
@testdox
- Required in test method docblocks (unit-tests.md)
Test file naming - Must follow convention for
```
includes/
```
vs
```
src/
```
(unit-tests.md)

参考

woocommerce-backend-dev

技能获取详细标准。以这些标准为指导，标记以下违规项及其他类似问题：

架构与结构：

独立函数 - 必须使用类方法（file-entities.md）
对DI管理的类使用
new
-
```
src/
```
目录下的类必须使用
```
$container->get()
```
（dependency-injection.md）
类位于
src/Internal/
目录外 - 除非明确声明为公共类，否则默认应放在该目录下（file-entities.md）

命名与规范：

使用camelCase命名 - 方法/变量/钩子必须使用snake_case（code-entities.md）
违反Yoda条件 - 必须遵循WordPress编码标准（coding-conventions.md）

文档：

缺少
@since
注解 - 公共/受保护方法和钩子必须添加该注解（code-entities.md）
缺少文档块 - 所有钩子和方法都必须添加文档块（code-entities.md）
冗长的文档块 - 保持简洁，理想状态为一行（code-entities.md）

数据完整性：

缺少验证 - 在删除/修改前必须验证状态（data-integrity.md）

测试：

在测试中使用
$instance
- 必须使用
```
$sut
```
变量名（unit-tests.md）
缺少
@testdox
- 测试方法的文档块中必须添加该注解（unit-tests.md）
测试文件命名 - 必须遵循
```
includes/
```
与
```
src/
```
目录的命名约定（unit-tests.md）

UI Text & Copy

UI文本与文案

Consult the

woocommerce-copy-guidelines

skill. Flag:

Title Case in UI - Must use sentence case (sentence-case.md)
- Wrong: "Save Changes", "Order Details", "Payment Options"
- Correct: "Save changes", "Order details", "Payment options"
- Exceptions: Proper nouns (WooPayments), acronyms (API), brand names

参考

woocommerce-copy-guidelines

技能。标记以下问题：

UI中使用标题大小写 - 必须使用句子大小写（sentence-case.md）
- 错误示例："Save Changes", "Order Details", "Payment Options"
- 正确示例："Save changes", "Order details", "Payment options"
- 例外情况：专有名词（如WooPayments）、首字母缩写（如API）、品牌名称

Review Approach

审查方法

Scan for critical violations listed above
Cite specific skill files when flagging issues
Provide correct examples from the skill documentation
Group related issues for clarity
Be constructive - explain why the standard exists when relevant

扫描上述严重违规项
标记问题时引用具体的技能文件
从技能文档中提供正确示例
将相关问题分组以提升清晰度
保持建设性 - 必要时解释该标准存在的原因

Output Format

输出格式

For each violation found:

text

[Issue Type]: [Specific problem]
Location: [File path and line number]
Standard: [Link to relevant skill file]
Fix: [Brief explanation or example]

对于每个发现的违规项：

text

[问题类型]: [具体问题]
位置: [文件路径和行号]
标准: [相关技能文件链接]
修复方案: [简要说明或示例]

Notes

注意事项

All detailed standards are in the

woocommerce-backend-dev

woocommerce-dev-cycle

, and

woocommerce-copy-guidelines

skills

Consult those skills for complete context and examples
When in doubt, refer to the specific skill documentation linked above

所有详细标准都在

woocommerce-backend-dev

、

woocommerce-dev-cycle

和

woocommerce-copy-guidelines

技能中

查阅这些技能获取完整背景和示例
如有疑问，请参考上述链接的具体技能文档