Công cụ làm đẹp mã PHP

Làm đẹp nghĩa là gì ở đây

Công cụ làm đẹp chỉ thay đổi bố cục. Mã phải làm cùng một việc trước và sau khi chỉnh sửa. Công cụ áp dụng một danh sách ngắn các quy tắc bố cục:

• Mỗi dấu chấm phẩy kết thúc một dòng.
• Mỗi dấu ngoặc nhọn mở được đặt trên dòng riêng, và mỗi dấu ngoặc nhọn đóng cũng vậy.
• Mã bên trong dấu ngoặc nhọn được thụt lề một cấp cho mỗi độ sâu lồng nhau.
• Dấu phẩy được theo sau bởi một khoảng trắng.
• Các dòng trống trong kết quả bị xóa.

Công cụ không thêm khoảng trắng quanh toán tử, không đổi tên gì và không sắp xếp lại mã.

Ví dụ trước và sau

Đầu vào:

<?php class User{private $name;public function getName(){return $this->name;}}

Kết quả với 4 khoảng trắng:

<?php class User
{
    private $name;
    public function getName()
    {
        return $this->name;
    }
}

Lưu ý rằng thẻ mở vẫn nằm cùng dòng với câu lệnh đầu tiên khi bạn dán mọi thứ trên một dòng. Đặt thẻ trên dòng riêng trong đầu vào nếu bạn muốn nó tách biệt.

Khi nào nên dùng công cụ khác

Công cụ coi dấu ngoặc nhọn và dấu chấm phẩy là ký tự thông thường. Nó không phân tích PHP, vì vậy không thể tuân theo hướng dẫn phong cách của dự án, ngắt các dòng dài hay sửa khoảng trắng quanh toán tử như = và +. Chú thích, heredoc và vòng lặp for (;;) có thể ra sai, vì dấu chấm phẩy bên trong chúng được xử lý như mọi dấu chấm phẩy khác. Với cả một codebase, hãy chạy một công cụ định dạng đã cấu hình trong trình soạn thảo hoặc quy trình build của bạn, và dùng trang này cho những lần dọn dẹp nhanh một lần.

Làm đẹp một hàm có vòng lặp

Đầu vào gọn:

function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Mỗi dấu ngoặc nhọn mở thêm một cấp mới, nên phần thân vòng lặp lùi vào hai cấp và return quay lại một cấp. Khi đọc từ trên xuống, bạn có thể thấy vòng lặp cộng dần vào $sum và hàm trả về giá trị đó sau đó. Trong phiên bản một dòng, điều này khó nhận ra.

Chọn 2 hay 4 khoảng trắng

Bốn khoảng trắng là độ rộng phổ biến trong mã PHP và dễ quét mắt nhất. Chọn 2 khi mã lồng sâu hoặc nơi bạn dán vào khá hẹp, chẳng hạn một tin nhắn chat. Cài đặt này chỉ thay đổi thụt lề, không bao giờ thay đổi ngắt dòng.

Kiểm tra kết quả

Mã đã làm đẹp dễ xem xét hơn, và đó chính là mục đích. Hãy đọc một lượt để tìm dấu ngoặc nhọn bị thiếu hoặc thừa, vì công cụ đếm chúng mà không báo lỗi. Nếu thụt lề bị lệch kỳ lạ về cuối, nguyên nhân thường gặp là một dấu ngoặc nhọn không cặp trong đầu vào.