[Series WHMCS] Modules - Phần 4: Style Guide 2019-10-22

WHM.vn cho ra mắt series tự học WHMCS giúp bạn thuận lợi hơn trong việc tìm hiểu và học tập về WHMCS

Tags:
  1. Trung
    Style Guide



    [​IMG]​


    Tiếp theo chúng tôi sẽ miêu tả rõ hơn về style lập trình được đề xuất và các kết quả tốt nhất khi bạn lập trình với WHMCS.

    PHP Code Tags

    Luôn luôn sử dụng     <?php ?> để định mã PHP, không phải tốc ký,<? ?>. Đây là định dạng tiện lợi nhất để đảm bảo khả năng tương thích cho các hệ điều hành và thiết lập khác.

    Nếu là một tệp mã PHP thuần túy, tốt hơn là nên bỏ qua thẻ đóng PHP ở cuối tệp. Điều này ngăn không cho các khoảng trắng ngẫu nhiên hoặc các dòng mới được thêm vào sau thẻ đóng PHP có thể gây ra các tác dụng phụ không mong muốn bao gồm lỗi "header already sent"(tiêu đề đã gửi), các vấn đề xác thực XHTML/XML và các vấn đề khác

    Thụt lề và khoảng trắng

    Sử dụng thụt lề 4 spaces, không tab.

    Các dòng không nên có khoảng trắng ở cuối.
    Các tệp phải được định dạng với     \n là kết thúc dòng(kết thúc dòng trong Unix), không phải \r n (kết thúc dòng trong Windows).

    Tất cả các tệp phải kết thúc bằng mộ dòng mới (\n). Điều này tránh được dòng cảnh báo “\ No newline at end of file” và làm cho chúng rõ ràng hơn những gì đang được thay đổi khi các dòng được thêm vào cuối tệp tin.

    Tiêu chuẩn mã hóa PSR

    Khuyển nghị tiêu chuẩn PHP hay tên tiếng anh là PHP Standard Recommendation(PSR) là một đặc tả PHP được xuất bản bởi the PHP Framework Interop Group. Nó bao gồm những gì nên được coi là các yếu tố mã hóa tiêu chuẩn được yêu cầu để đảm bảo mức độ tương tác kỹ thuật cao giữa mã PHP được chia sẻ.

    Tại WHMCS, chúng tôi tuân theo các tiêu chuẩn     PSR-1 và PSR-2 cho tất cả các mã chúng tôi tạo và chúng tôi thực sự khuyên bạn nên làm như vậy:

    Tiêu chuẩn mã hóa cơ bản: http://www.php-fig.org/psr/psr-1/
    Hướng dẫn về kiểu mã hóa: http://www.php-fig.org/psr/psr-2/

    Mã hóa ký tự

    Tất cả các tệp PHP phải được mã hóa bằng UTF-8 without BOM (không có dấu thứ tự byte).

    Bài viết được tham khảo và lược dịch từ: https://developers.whmcs.com/modules/style-guide/
    Tôi hi vọng bài viết đã giải đáp thắc mắc của bạn. Nếu chúng tôi có thể giúp đỡ gì thêm, xin vui lòng comment hoặc liên hệ email: [email protected]