Trang chủ » Coding convention là gì? Những điều bạn cần biết

Coding convention là gì? Những điều bạn cần biết

Đinh Thao 8 Th11, 2021

Coding convention là một thuật ngữ mà có lẽ bất kể các lập trình viên nào cũng từng nghe nói đến. Mặc dù trên thực tế thì việc tuân thủ theo coding convention hay việc không ảnh hưởng đến các kết quả của công việc là một điều khó.

Việc các hàm vẫn chạy, code vẫn thực thi đúng theo yêu cầu  và sản phẩm sẽ không có gì khác biệt. Vậy coding convention là gì? Hãy cùng trung tâm testerpro tìm hiểu về coding convention qua bài viết dưới đây.

Coding convention là gì

Coding convention là gì

Coding convention là gì

coding convention là một tập hợp các quy tắc chung đối với các lập trình nhằm giúp đạt được việc code dễ đọc, dễ hiểu để từ đó giúp cho việc quản lý dễ dàng và bảo trì nhanh chóng, thuận tiện hơn. Hiểu một cách đơn giản hơn nó là những quy ước coding, các quy ước về phong cách code, cách đặt tên biến, tên file, tên hàm, …để giúp các lập trình viên tuân theo.

Nó giúp bạn rất nhiều trong khi làm việc nhóm, cũng như trong khi làm việc với hệ thống lớn, được thiết kế cũng như bảo trì rất nhiều giai đoạn với các nguồn nhân lực khác nhau thì việc tuân thủ coding convention là vô cùng quan trọng giúp cho những lập trình viên đọc code lại dễ dàng cũng như tiết kiệm được thời gian khi đọc code có các quy ước đặt tên rõ ràng hơn. Cũng như việc giúp cho những người code sau trong việc bảo trì và phát triển hệ thống.

Các định danh như các hằng, biến, lớp, đối tượng, phương thức,… nên được đặt bằng tiếng anh đúng chính tả và có nghĩa.

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

Cú pháp CamelCase(Cú pháp lạc đà): Với ký tự đầu tiên viết thường những ký tự đầu tiên của ký tự tiếp theo được viết hoa, ví dụ như: thisIsThe Name, product Price,….

Cú pháp Pascal Case(Pascal): Viết hoa chữ cái đầu tiên ví dụ như: ProductPrice, ProductName,…

Cú pháp Snake_case(con rắn): Tất cả chữ cái đều viết thường  và cách nhau bởi dấu gạch dưới như: product_name, product_price,…

Một số nguyên tắc đặt tên

Thường các Tên biến, tên lớp: Thường là cụm danh từ hoặc danh từ, tính từ như UserModel, userName, isDownloaded.

Tên biến, tên hàm được đặt theo CamelCase hoặc snake_case.

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

Hằng số: được đặt theo UPPER_CASE.

Đặt tên phải có nghĩa và không được đặt tên kiểu viết tắt như uName, pName, a1,…

Tránh đặt những cái tên quá chung chung hay tối nghĩa: như top, getAll,…

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

Hàm không nên sử dụng quá 30 dòng.

lớp không nên để vượt qua 500 dòng.

Một hàm không được vượt quá 5 tham số nên giữ dưới hoặc bằng 3.

Hàm chỉ làm một việc duy nhất, trong trường hợp chính đáng, bạn có thể làm 2 việc được phép tuy nhiên tên hàm phải nói rõ ràng về điều này.

Khi bạn khai báo biến thì một dòng chỉ chứa một biến .

Một dòng không nên để quá dài 80 ký tự.

Các câu lệnh được lồng nhau tối đa 4 cấp.

Quy tắc xuống hàng

Theo Oracle: Dấu phẩy thì xuống hàng sau dấu phẩy.

Xuống hàng trước toán tử +,-,x,….

Có nhiều cặp lồng vào nhau, thì xuống hàng phải theo từng cấp.

Dòng xuống hàng mới thì được bắt đầu ở cùng cột với các đoạn lệnh cùng cấp ở trên.

Comment

Hạn chế việc dùng comment để giải thích về code do đó hãy cải thiện lại các đoạn code.

Chỉ nên dùng comment vào các trường hợp documentation hay cho các thư viện, các thông tin được đính kèm cho class.

Các quy chuẩn trong việc viết code PHP

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

Các quy chuẩn bắt buộc bạn phải tuân theo:

Mỗi namespace và các class phải tuân thủ đầu đủ các điều kiện và phải có cấu trúc như sau\()*.

mỗi namespace cần phải có một top-level namespace tạm gọi là namespace gốc.

Mỗi namespace có nhiều sub-namespace.

Từ php 5.3 khi khai báo class bạn bắt buộc phải khai báo các namespace.

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

Code phải được viết trong các cặp thẻ và được sử dụng cặp thẻ ngăn thay cho echo.

Code sử dụng UTF-8 không có Byte Order Mark.

Các Namespace tuân theo chuẩn PSR autoloading.

Tên class viết theo quy tắc PascalCase hay còn được biết các tên khác StudlyCaps.

Các hằng số phải viết hoa tất cả và phân tích cách nhau bằng dấu gạch chân.

Mỗi file PHP chỉ làm 1 nhiệm vụ duy nhất, tránh sự chồng chéo.

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

Code cần tuân thủ PSR-1 & PSR-0, việc sử dụng 4 khoảng trắng space để thụt dòng, tuyệt đối không được sử dụng tab, các ký tự trên cũng 1 dòng và không được vượt quá 120 ký tự, nên để nhỏ hơn hoặc bằng 80 ký tự và không nên có ký tự  trắng ở cuối dòng . Cần phải có space sau khi khai báo namespace và sau khi khai báo use 

thẻ đóng và mở của một hàm {} phải nằm riêng biệt trên cùng dòng và trước đó cần phải có space( khoảng trắng)

Dùng dấu nháy đơn để khai báo các chuỗi không chứa các biến, nếu chuỗi có chứa các ký tự thì dấu nháy ở ngoài

nếu bạn dùng abstract, final hay static để khai báo hàm cần phải khai báo số thứ tự 

Cần để space trước và sau các phép toán, khi ép kiểu có space để ngăn các kiểu dữ liệu và biến được ép kiểu

Đinh Thao

Đinh Thao

Tôi là Đinh Thị Thao, hiện đang là giáo viên giảng dạy tại trung tâm testerpro và cũng là tác giả chính các bài blog liên quan đến tester, ngành công nghệ thông tin tại trên trang testerpro.vn. Với 5 năm kinh nghiệm làm việc, giảng dậy tại trung tâm thì tôi hy vọng sẽ có thể truyền tải cho các bạn những kiến thức tốt nhất của tester giúp các bạn phục vụ trong công việc của bản thân.

Từ khóa:
Bình luận
Icon Phone Icon Zalo