企业官网建设流程全解析

PHP可读性代码编写指南

代码是写给人看的。可读性差的代码不仅难以维护，也容易产生bug。今天说说提高PHP代码可读性的方法。

命名是代码可读性的基础。

```php
// 不好的命名
$a = 28;
$b = '张三';
function f($x, $y) { return $x * $y / 100; }

// 好的命名
$userAge = 28;
$userName = '张三';
function calculateTax(float $amount, float $rate): float
{
return $amount * $rate / 100;
}
?>

函数应该只做一件事。

```php
// 不好的函数
function processUser(array $user): void
{
// 验证用户
if (empty($user['name'])) throw new Exception('名称不能为空');
// 保存数据库
$pdo->prepare("INSERT INTO users ...");
// 发送邮件
mail($user['email'], '欢迎', '...');
// 更新缓存
$cache->set("user:{$user['id']}", $user);
}

// 好的函数
function validateUser(array $user): void
{
if (empty($user['name'])) throw new Exception('名称不能为空');
}

function saveUser(array $user): void
{
$pdo->prepare("INSERT INTO users ...");
}

function sendWelcomeEmail(string $email): void
{
mail($email, '欢迎', '...');
}

function updateUserCache(array $user): void
{
$cache->set("user:{$user['id']}", $user);
}
?>

减少嵌套深度。

```php
// 不好的嵌套
function processOrder(?array $order): void
{
if ($order !== null) {
if ($order['status'] === 'pending') {
if ($order['amount'] > 0) {
// 处理...
}
}
}
}

// 好的方式
function processOrderRefactored(?array $order): void
{
if ($order === null) return;
if ($order['status'] !== 'pending') return;
if ($order['amount'] <= 0) return;
// 处理...
}
?>

使用类型声明。

```php
declare(strict_types=1);

function calculateTotal(float $price, int $quantity, float $taxRate = 0.13): float
{
$subtotal = $price * $quantity;
$tax = $subtotal * $taxRate;
return $subtotal + $tax;
}

echo calculateTotal(99.99, 3);
?>

保持一致性的代码风格。

```php
// 统一的缩进和花括号位置
class UserController
{
public function index(): array
{
$users = $this->repository->findAll();

if (empty($users)) {
return [];
}

return ['data' => $users];
}
}
?>

可读性好的代码有几个特征。命名清晰表达意图，函数简短只做一件事，减少嵌套深度，类型声明明确参数和返回值。代码规范工具可以自动化检查风格，但好的设计需要开发者自己把握。写代码的时候多想想读代码的人会怎么理解，代码的可读性就会好很多。