PHP变量命名最佳实践

PHP变量命名最佳实践

好的命名让代码自文档化。PHP的变量命名有一些约定俗成的规则。今天说说变量命名的常用实践。

变量的命名风格。

```php
// camelCase（变量名、方法名、函数名）
$userName = '张三';
$orderTotal = 299.99;

function getUserById(int $id): ?array {}
class UserService {
public function findActive(): array {}
}

// PascalCase（类名、接口名、trait名）
class UserController {}
interface LoggerInterface {}
trait Timestampable {}

// UPPER_SNAKE_CASE（常量）
const MAX_LOGIN_ATTEMPTS = 5;
define('API_VERSION', '1.0');

// snake_case（配置键、数据库字段）
$config = ['db_host' => 'localhost', 'max_attempts' => 5];
?>

命名要表达意图。

```php
// 不好的命名
$d = 28; // 年龄
$l = ['张三', '李四']; // 用户列表
function p($u) {} // 处理用户

// 好的命名
$userAge = 28;
$userList = ['张三', '李四'];
function processUser(array $user): void {}
?>

指针和引用的命名。

```php
// 在foreach中用&时，后面必须unset
$items = [1, 2, 3, 4, 5];
foreach ($items as &$value) {
$value *= 2;
}
unset($value);

// 循环变量命名
for ($i = 0; $i < 10; $i++) {}
for ($userId = 0; $userId < 10; $userId++) {}
foreach ($users as $index => $user) {}
foreach ($users as $user) {}
?>

临时变量命名。

```php
// 临时变量用短名称
$i = 0;
$e = new Exception('错误');

// 但也不要用单字母滥用
// 好的临时变量
$count = 0;
$total = 0;
$result = $service->process();
$exists = $repository->find($id) !== null;
?>

布尔变量的命名。

```php
$isActive = true;
$hasPermission = false;
$canEdit = true;
$shouldNotify = false;
$loggedIn = true;

if ($isActive && $hasPermission && $canEdit) {
// 处理
}
?>

集合变量的复数形式。

```php
$users = [];
$userList = [];
$orderIds = [];
$tags = ['php', '编程', 'web'];

foreach ($users as $user) {
echo $user['name'] . "\n";
}
?>

好的命名规范让代码更容易理解。同一项目保持命名风格一致。命名要表达业务含义而不是技术细节。变量命名要能清楚地表明其用途和类型。