Hướng dẫn php method naming convention - quy ước đặt tên phương thức php

1. Convention là gì ?

  • Coding conventions là tập hợp những nguyên tắc chung khi lập trình nhằm làm cho code dễ đọc, dễ hiểu, do đó dễ quản lý, bảo trì hơn.là tập hợp những nguyên tắc chung khi lập trình nhằm làm cho code dễ đọc, dễ hiểu, do đó dễ quản lý, bảo trì hơn.
  • Ví dụ: Nếu ta xem code của chúng ta như là một cô gái. Thì chúng ta thích một cô gái xinh đẹp, sạch sẽ hay thích một cô gái xấu xí lại còn lôi thôi ? Và tôi nghĩ chúng ta có câu trả lời rồi đúng không. Còn nếu không phải giống tôi nghĩ thì chúc mừng bạn:)))
  • Coding conventions có những điểm chung và điểm riêng biệt tuỳ theo ngôn ngữ, tuỳ theo cộng đồng, nhưng được đa số các lập trình viên trên thế giới hầu công nhận và làm theo.

2. Quy tắc đặt tên (Naming Convention)

Các cú pháp thông dụng

2.1 Cú pháp lạc đà (camelCase)

  • Cú pháp: Ký tự đầu tiên của từ đầu tiênviết thường, những ký tự đầu tiên của những từ tiếp theoviết hoa.: Ký tự đầu tiên của từ đầu tiên viết thường, những ký tự đầu tiên của những từ tiếp theo viết hoa.
  • Ví dụ: productName, productPrice, thisIsTheNameFollowTheCamelCase

2.2 Cú pháp Pascal (PascalCase)

  • Cú pháp: viết hoa chữ cái đầu tiên của mỗi từ.: viết hoa chữ cái đầu tiên của mỗi từ.
  • Ví dụ: ProductName, ProductPrice, ThisIsTheNameFollowThePascalCase

2.3 Cú pháp con rắn (snake_case)

  • Cú pháp: Tất cả các chữ cái đều viết thường, và các từcách nhau bởi dấu gạch dưới.: Tất cả các chữ cái đều viết thường, và các từ cách nhau bởi dấu gạch dưới.
  • Ví dụ: product_name, product_price, this_is_the_name_follow_the_snake_case

=> Tuỳ vào mỗi ngôn ngữ lập trình và cộng đồng định nghĩa, ta sẽ lựa chọn cú pháp phù hợp.

Nội dung chính ShowShow

  • 1. Convention là gì ?
  • 2. Quy tắc đặt tên (Naming Convention)
  • Các cú pháp thông dụng
  • 2.1 Cú pháp lạc đà (camelCase)
  • 2.2 Cú pháp Pascal (PascalCase)
  • 2.3 Cú pháp con rắn (snake_case)
  • Cú pháp: Tất cả các chữ cái đều viết thường, và các từcách nhau bởi dấu gạch dưới.
  • Ví dụ: product_name, product_price, this_is_the_name_follow_the_snake_case
  • => Tuỳ vào mỗi ngôn ngữ lập trình và cộng đồng định nghĩa, ta sẽ lựa chọn cú pháp phù hợp.
  • Nội dung chính Show
  • Một số nguyên tắc:
  • Quy tắc về số lượng
  • Quy tắc xuống hàng

Cú pháp: Tất cả các chữ cái đều viết thường, và các từcách nhau bởi dấu gạch dưới.

Ví dụ: product_name, product_price, this_is_the_name_follow_the_snake_caseTên lớp: đặt theo PascalCase.

=> Tuỳ vào mỗi ngôn ngữ lập trình và cộng đồng định nghĩa, ta sẽ lựa chọn cú pháp phù hợp.Tên biến, tên hàm: đặt theo camelCase hoặc snake_case.

Nội dung chính ShowHằng số: đặt theo UPPER_CASE. VD: CLICK_COUNTER.

Một số nguyên tắc:Tên biến, tên lớp: thường là danh từ, cụm danh từ hoặc tính từ. VD: UserModel, userName, downloadCounter, isDownloaded.

Quy tắc về số lượngTên hàm thường** bắt đầu bằng động từ**. VD: getUserName, setUserName, increaseDownloadCounter.

Quy tắc xuống hàngTên phải có nghĩa, không được đặt tên kiểu viết tắt. VD: uName, pName, idl, a, a1, doFA.

3. Chuẩn viết code trong PHPTránh đặt những tên quá chung chung, tối nghĩa. VD: top, doIncrease, getAll.

Ví dụ: product_name, product_price, this_is_the_name_follow_the_snake_case

=> Tuỳ vào mỗi ngôn ngữ lập trình và cộng đồng định nghĩa, ta sẽ lựa chọn cú pháp phù hợp.

  • Nội dung chính Show
  • Một số nguyên tắc:

Quy tắc về số lượng

Quy tắc xuống hàng

3. Chuẩn viết code trong PHP

Chuẩn PSR-0, PSR-4: Chuẩn Autoloading

Chuẩn PSR-1 : Các chuẩn cơ bản

Chuẩn PSR-2: Chuẩn viết code

– Tên lớp: đặt theo PascalCase.

=> Tuỳ vào mỗi ngôn ngữ lập trình và cộng đồng định nghĩa, ta sẽ lựa chọn cú pháp phù hợp.

Nội dung chính Show

Một số nguyên tắc:

        someMethod(longExpression1, longExpression2, longExpression3, 
                longExpression4, longExpression5);

        var = someMethod1(longExpression1,
                        someMethod2(longExpression2,
                                longExpression3)); 

Quy tắc về số lượng

        longName1 = longName2 * (longName3 + longName4 - longName5)
                   + 4 * longname6; // PREFER

        longName1 = longName2 * (longName3 + longName4
                               - longName5) + 4 * longname6; 

Quy tắc xuống hàng

3. Chuẩn viết code trong PHP

Chuẩn PSR-0, PSR-4: Chuẩn Autoloading

  • Chuẩn PSR-1 : Các chuẩn cơ bản
  • Chuẩn PSR-2: Chuẩn viết code

Nội dung chính Show

Một số nguyên tắc:

  • Quy tắc về số lượng
  • Quy tắc xuống hàng

Một số nguyên tắc:

Quy tắc về số lượng

Quy tắc xuống hàng

3. Chuẩn viết code trong PHP

Chuẩn PSR-0, PSR-4: Chuẩn Autoloading

Chuẩn PSR-1 : Các chuẩn cơ bản

Quy tắc về số lượng

Quy tắc xuống hàng

3. Chuẩn viết code trong PHP

Chuẩn PSR-0, PSR-4: Chuẩn Autoloading

Chuẩn PSR-1 : Các chuẩn cơ bản

– Namespace phải tuân theo chuẩn PSR “autoloading” (PSR-0, PSR-4).

– Tên class phải viết theo quy tắc PascalCase( hay tên khác StudlyCaps).

– Các hẳng số phải viết hoa tất cả các chữ, cách nhau bằng dấu gạch chân.

– Tên phương thức viết theo quy tắc camelCase.

Chuẩn PSR-2: Chuẩn viết code

  • Code phải tuân thủ PSR-1 & PSR-0.
  • Sử dụng 4 khoảng trắng(spaces) để thụt dòng, tuyệt đối không dùng tab (bạn có thể khai báo trong công cụ lập trình để khi ấn tab nó tương đương với việc thụt vào 4 spaces).
  • Trên 1 dòng không vượt quá 120 kí tự, tốt nhất nên nhỏ hơn hoặc bằng 80 kí tự, không nên có kí tự trắng ở cuối dòng.
  • Phải có 1 dòng trắng sau khi khai báo namespace và phải có 1 dòng trắng sau các khai báo use.
  • Thẻ đóng và mở của 1 hàm {} phải nằm riêng biệt trên một dòng.
  • Trước thẻ mở và đóng hàm {} thì không được có 1 dòng trắng.
  • Phải dùng dấu nháy đơn ‘ để khai báo chuỗi không chứa biến, nếu chuỗi có chứa kí tự ‘ thì dùng dấu nháy kép để bọc bên ngoài (chúng ta rất hay nhầm vấn đề này).
  • Dùng dấu . để nối chuỗi, chú ý trước và sau dấu chấm . phải có khoảng trắng. Nếu chuỗi quá dài thì tách làm nhiều dòng và dấu chấm được đặt đầu dòng ngang với dấu bằng.
  • Các tham số truyền vào hàm phải có 1 dấu cách trước dấu phẩy, bạn có thể tách thành nhiều dòng nhưng phải thụt lề 1 đơn vị.
  • Đối với khối lệnh switch case thì case phải lùi 4 khoảng trắng so với switch, và các lệnh trong case cũng phải lùi 4 khoảng trắng so với case. Phải có từ khóa break hoặc return, trong trường hợp nào không có thì phải comment //no break
  • Nếu phải sử dụng abstract và final hay static để khai báo hàm thì bạn phải khai báo theo thứ tự.
  • Phải có 1 khoảng trắng trước và sau phép toán, khi ép kiểu thì phải có 1 khoảng trắng ngăn cách giữa kiểu dữ liệu và biến được ép kiểu.