Coding convention là gì? 4 quy tắc Coding Convention Coder cần nhớ
- 28/06/2022
- LANIT JSC
Coding convention là một thuật ngữ mà bất cứ Coder nào cũng từng nghe đến trong sự nghiệp lập trình của mình. Nhưng với người mới lập trình có lẽ không tránh khỏi những bỡ ngỡ. Vậy Coding convention là gì? Mời các anh chị cùng LANIT tìm hiểu về thuật ngữ này và tham khảo 4 quy tắc Coding Convention cần nhớ khi lập trình mà chúng tôi chia sẻ ngày hôm nay nhé!
Coding convention là gì?
Coding convention là một tập hợp các quy tắc chung mà người lập trình viên cần ghi nhớ để đạt được hiệu quả cao trong quá trình viết code, quản lý code, sửa chữa. Đó là những quy ước: Về coding, về phong cách code, cách đặt tên biến, tên file, tên hàm,…
Các quy tắc này giúp cho Coder tạo ra những đoạn code dễ đọc, dễ hiểu. Đặc biệt với những dự án lớn cần kết hợp làm nhóm, Coding Convention giúp tất cả thành viên có thể đọc và chỉnh sửa code dễ dàng, thuận tiện cho việc bảo trì cũng như phát triển hệ thống website, ứng dụng…
Ưu điểm khi sử dụng Coding Convention
Sẽ thật khó khăn nếu website của bạn gặp vấn đề về code nhưng bạn lại không thể phát hiện được code lỗi ở đâu để chỉnh sửa. Điều đó khiến cho công việc của doanh nghiệp / cá nhân bị gián đoạn, thậm chí còn gây tổn thất lớn về kinh tế
Đối với Coding Convention, mọi thứ trở nên đơn giản hơn rất nhiều, lập trình viên nhanh chóng xử lý và giải quyết mọi vấn đề trong thời gian ngắn nhất. Những ưu điểm tuyệt vời khi sử dụng các quy tắc lập trình này, như là:
- Dễ dàng nhận biết lỗi code sai, dễ dàng nâng cấp và phát triển phần mềm.
- Làm việc theo nhóm hiệu quả hơn.
- Tiết kiệm thời gian, tối ưu web nhanh chóng.
- Có thể tái sử dụng trong các phần mềm khác nhau.
Bốn Quy tắc Coding Convention Coder cần nhớ khi lập trình
Để lập trình nhanh chóng và thuận lợi cho việc chỉnh sửa, phát triển hệ thống web, phần mềm trong tương lai, người lập trình cần ghi nhớ 4 quy tắc Coding Convention vàng dưới đây.
1. Quy tắc đặt tên
Quy tắc đặt tên – đây là Quy tắc đầu tiên trong Coding Convention. Việc định danh các biến, các hằng hay class trong khi lập trình sẽ giúp người khác hiểu được code của bạn viết những gì.
Trong quy tắc đặt tên có 3 cú pháp mà người lập trình có thể áp dụng và tuân theo: Cú pháp CamelCase (cú pháp lạc đà), cú pháp Pascal Case và cú pháp Snake Case (cú pháp con rắn).
- Cú pháp lạc đà: Quy ước ký tự đầu tiên viết thường, những ký tự đầu tiên của chữ cái tiếp theo viết hoa.
Ví dụ: personOne, textUtil, thingsToDo
- Cú pháp Pascal Case: Chữ cái đầu tiên viết hoa.
Ví dụ: PersonOne, TextUtil, ThingsToDo
- Cú pháp Snake: Các chữ cái đều viết thường và các từ được phân tách bởi dấu gạch dưới.
Ví dụ: person_one, text_util, things_to_do
Ngoài ra, khi đặt tên, lập trình viên cần tuân theo các nguyên tắc đặt tên sau:
- Tên biến, tên lớp thường là cụm danh từ, danh từ hoặc tính từ. Ví dụ: userName, someVariable
- Tên biến, hàm sẽ đặt theo cú pháp Camel hoặc Snake.
- Tên lớp đặt theo cú pháp Pascal.
- Các hằng số đặt theo Upper_Case.
- Khi đặt tên phải có ý nghĩa, không đặt theo kiểu viết tắt.
- Không đặt tên chung chung, tên tối nghĩa.
2. Quy tắc số lượng
Trong Coding Convention, quy tắc về số lượng được nêu rất cụ thể để Coder dễ dàng thực hiện.
- Các hàm không được quá 30 dòng.
- Các lớp không vượt quá 500 dòng.
- Mỗi hàm không được vượt quá 5 tham số. Tốt nhất lập trình viên nên giữ dưới mức 3 hoặc bằng 3.
- Hàm chỉ thực hiện một việc duy nhất.
- 1 Dòng chỉ chứa 1 biến.
- Mỗi dòng không được quá 80 ký tự và các câu lệnh được lồng vào nhau không quá 4 cấp.
3. Quy tắc xuống hàng
Đối với quy tắc xuống hàng trong Coding Convention, Coder cần lưu ý những quy tắc sau.
- Dấu phẩy phải xuống hàng sau dấu phẩy.
- Xuống hàng trước các toán tử +, -. x, :,…
- Nếu có nhiều cặp lồng ghép với nhau thì cần xuống hàng theo từng cấp.
- Dòng xuống hàng mới phải bắt đầu ở cùng cột với các đoạn lệnh cùng cấp ở dòng trên.
4. Quy tắc comment
Trong comment cần đảm bảo các quy tắc:
- Không nên dùng comment để giải thích về code mà nên cải thiện lại các đoạn code.
- Chỉ dùng comment trong trường hợp documentation, các thông tin đính kèm cho class hoặc cho các thư viện.
Một số câu hỏi thường gặp về Coding convention
1. Khi code có phải cần thiết phải biết Coding Convention không?
Người lập trình không chỉ cần thiết phải biết rõ Coding Convention, nhưng nên nắm vững các quy tắc lập trình này. Chỉ khi hiểu và tuân theo những quy tắc lập trình viên mới có thể lập trình chuyên nghiệp.
2. Coding convention java là gì?
Coding convention java đây là quy ước đặt tên cho các định danh như: Lớp, gói, biến hằng, phương thức,… Lập trình viên cần tuân theo những quy ước trong Java để tránh nhầm lẫn khi viết code.
Tất cả các lớp, giao diện, gói, phương thức và trường ngôn ngữ lập trình Java được đưa ra theo quy ước đặt tên Java. Để đặt tên cho lớp, giao diện, phương thức và biến, Java tuân theo cú pháp Camel-Case.
Nếu tên được kết hợp từ 2 từ, thì từ thứ 2 bắt đầu bằng chữ cái viết hoa
Ví dụ: actionPerformed.
3. Coding convention c# là gì?
Coding convention C# là các quy tắc về cách đặt tên, tiền tố, quy ước về viết câu lệnh, khối mã nguồn, thụt đầu dòng, khoảng cách, chú thích, ngôn ngữ sử dụng và quy định phân bố mã nguồn trong quá trình viết code. Coder sáng tạo, bảo trì, phát triển về sau.
Một số quy tắc, quy ước trong C# như sau:
- Tên biến đặt theo kiều Camel Case (Ví dụ: firstName) và được đặt tên theo danh từ.
- Hằng số được đặt tên theo kiểu Uppercase, có gạch chân ở dưới (FIRST).
- Tên class, enum đặt theo kiểu Pascal là danh từ (Create User).
- Thuộc tính đặt tên theo Pascal Case (Background Color) và là danh từ
4. Coding convention Php là gì?
Coding Convention php chính là các quy tắc phổ biến nhất khi code ngôn ngữ lập trình PHP. Nó quy định phong cách code, cách đặt tên biến, tên hàm, class,… Nguyên tắc trong coding Php đó là:
- Chỉ được phép sử dụng <?php (dùng để mở đầu) và <?=
- Các file code Php sử dụng encode UTF-8 without BOM.
- File Php chỉ nên dùng để khai báo các thành phần của Php (function, const, class) và các hiệu ứng phụ của nó (include, thiết lập init Php)
5. Coding convention Python là gì?
Cũng giống như các quy tắc lập trình code trên, Python Coding Convention là những quy tắc về cách đặt tên, thụt lề, thụt dòng và giao diện giúp người lập trình thực hiện các dòng code tốt nhất.
Trong Python không sử dụng CamelCase mà thay vào đó là Pascal Case và Snake_Case. Đối với cách thụt lề, khoảng trắng đầu dòng rất quan trọng. Mức độ thụt dòng trong code Python giúp xác định được các nhóm, các dòng code.
Trên đây, LANIT vừa giúp các bạn tìm hiểu Coding Convention là gì và 4 quy tắc quan trọng mà các Coder cần ghi nhớ trong khi lập trình code. Chúc các bạn sẽ có trải nghiệm tuyệt vời với công việc sáng tạo code của mình.
LANIT – Đơn vị cung cấp dịch vụ lưu trữ uy tín
- Hosting giá rẻ
- VPS giá rẻ – ổn định cao
- Thuê máy chủ giá rẻ – chất lượng
Cảm ơn bạn đã đọc!
