Naming convention là các quy tắc được đặt ra để định danh tên cho các đối tượng, biến, hàm, lớp và các thành phần khác trong chương trình. Naming convention giúp cho code trở nên dễ đọc, dễ hiểu, dễ bảo trì và dễ mở rộng.
Các bài viết liên quan:
Các quy tắc đặt tên thường được định nghĩa bởi ngôn ngữ lập trình hoặc do tổ chức, nhóm phát triển hoặc cá nhân đặt ra. Ví dụ, các quy tắc đặt tên trong Java bao gồm:
- Tên lớp nên bắt đầu bằng chữ cái viết hoa và các từ tiếp theo cũng bắt đầu bằng chữ cái viết hoa. Ví dụ: CustomerOrder, Employee, Product.
- Tên biến nên bắt đầu bằng chữ cái thường và sử dụng chữ cái viết hoa cho các từ tiếp theo. Ví dụ: firstName, lastName, productId.
- Tên phương thức cũng nên bắt đầu bằng chữ cái viết thường và các từ tiếp theo cũng bắt đầu bằng chữ cái viết hoa. Ví dụ: getOrderDetails(), calculateTotal().
- Tên hằng số nên được viết bằng chữ cái in hoa và các từ được phân tách bằng dấu gạch dưới. Ví dụ: MAX_VALUE, MIN_VALUE.
Quy tắc đặt tên giúp cho code trở nên dễ đọc, dễ hiểu, dễ bảo trì và dễ mở rộng. Tuy nhiên, quan trọng là tuân thủ các quy tắc đặt tên cụ thể cho ngôn ngữ lập trình hoặc quy tắc được đặt ra trong tổ chức hoặc dự án để đảm bảo tính nhất quán trong code.
Tại sao cần sử dụng name convention
Sử dụng naming convention trong lập trình là rất quan trọng vì nó có các lợi ích sau:
- Dễ đọc: Các đối tượng, biến, hàm, lớp và các thành phần khác trong chương trình được đặt tên theo các quy tắc rõ ràng và dễ hiểu giúp cho code trở nên dễ đọc hơn. Nếu tên được đặt một cách logic và rõ ràng, người đọc code có thể hiểu được chức năng của một đối tượng hoặc hàm chỉ bằng cách nhìn vào tên.
- Dễ bảo trì: Sử dụng naming convention giúp cho code trở nên dễ bảo trì hơn. Nếu các tên được đặt đúng cách, khi cần sửa code hoặc thêm mới các chức năng, các nhà phát triển có thể tìm kiếm, đọc hiểu và chỉnh sửa code một cách nhanh chóng và dễ dàng hơn.
- Dễ mở rộng: Các quy tắc đặt tên trong naming convention giúp cho code trở nên dễ mở rộng hơn. Khi thêm mới các chức năng hoặc đối tượng mới vào code, các nhà phát triển có thể dễ dàng đặt tên mới theo quy tắc đã được định nghĩa trước đó, giúp cho code trở nên nhất quán và dễ đọc hơn.
- Tính nhất quán: Sử dụng naming convention giúp cho code trở nên nhất quán trong cả codebase, giúp cho việc đọc, sửa code trở nên dễ dàng và tiết kiệm thời gian.
Vì vậy, sử dụng naming convention là rất cần thiết trong lập trình để tạo ra code dễ đọc, dễ bảo trì, dễ mở rộng và nhất quán.
Một số quy tắc name convention trong java
Một số quy tắc naming convention trong Java gồm:
- Đặt tên lớp:
- Tên lớp nên được viết bằng chữ cái in hoa ở đầu mỗi từ, không sử dụng dấu gạch dưới.
- Tên lớp nên đặt sao cho mô tả chức năng của lớp.
Ví dụ: class Customer, class Product
- Đặt tên thuộc tính:
- Tên thuộc tính nên bắt đầu bằng chữ cái thường và sau đó là chữ cái in hoa ở đầu mỗi từ tiếp theo, không sử dụng dấu gạch dưới.
- Tên thuộc tính nên mô tả rõ ràng về thông tin mà thuộc tính đang lưu trữ.
Ví dụ: int customerId, String productName
- Đặt tên phương thức:
- Tên phương thức nên bắt đầu bằng chữ cái thường và sau đó là chữ cái in hoa ở đầu mỗi từ tiếp theo, không sử dụng dấu gạch dưới.
- Tên phương thức nên mô tả rõ ràng về chức năng mà phương thức thực hiện.
Ví dụ: void printCustomerName(), int calculateTotalPrice()
- Đặt tên biến:
- Tên biến nên bắt đầu bằng chữ cái thường và sau đó là chữ cái in hoa ở đầu mỗi từ tiếp theo, không sử dụng dấu gạch dưới.
- Tên biến nên mô tả rõ ràng về giá trị mà biến đang lưu trữ.
Ví dụ: int age, String fullName
- Đặt tên hằng:
- Tên hằng nên viết hoa toàn bộ và các từ cách nhau bằng dấu gạch dưới.
- Tên hằng nên mô tả rõ ràng về giá trị mà hằng đang lưu trữ.
Ví dụ: final int MAX_NUMBER, final String DATABASE_NAME
Các quy tắc naming convention giúp cho code trở nên dễ đọc, dễ bảo trì và nhất quán.
- Đặt tên gói:
- Tên gói nên được viết bằng chữ cái thường và đặt theo kiểu chuẩn của tên miền ngược lại.
- Tên gói nên có ý nghĩa rõ ràng về chức năng của gói.
Ví dụ: com.example.projectname.util, com.example.projectname.controller
- Đặt tên tham số:
- Tên tham số nên bắt đầu bằng chữ cái thường và sau đó là chữ cái in hoa ở đầu mỗi từ tiếp theo, không sử dụng dấu gạch dưới.
- Tên tham số nên mô tả rõ ràng về giá trị mà tham số đang truyền vào.
Ví dụ: void printCustomerName(String customerName), int calculateTotalPrice(int[] items)
- Đặt tên enum:
- Tên enum nên được viết bằng chữ cái in hoa toàn bộ và các từ cách nhau bằng dấu gạch dưới.
- Tên enum nên mô tả rõ ràng về giá trị mà enum đang đại diện.
Ví dụ: enum Color {RED, BLUE, GREEN}
- Đặt tên annotation:
- Tên annotation nên bắt đầu bằng ký tự @ và sau đó là chữ cái in hoa ở đầu mỗi từ tiếp theo, không sử dụng dấu gạch dưới.
- Tên annotation nên mô tả rõ ràng về chức năng mà annotation đang cung cấp.
Ví dụ: @Deprecated, @Override
- Đặt tên file:
- Tên file nên được viết bằng chữ cái thường và sử dụng dấu gạch dưới để ngăn cách các từ.
- Tên file nên mô tả rõ ràng về chức năng của file.
Ví dụ: user_service_impl.java, customer_data.txt
- Đặt tên biến boolean:
- Biến boolean nên bắt đầu bằng động từ thể hiện giá trị của biến.
- Tên biến boolean nên mô tả rõ ràng về giá trị mà biến đang đại diện.
Ví dụ: isAvailable, hasPermission
- Đặt tên biến lặp:
- Tên biến lặp nên ngắn gọn và mô tả rõ ràng về giá trị mà biến đang lưu trữ.
Ví dụ: for(int i = 0; i < 10; i++), for(String s : stringArray)
- Đặt tên biến static và final:
- Tên biến static và final nên được viết bằng chữ cái in hoa toàn bộ và các từ cách nhau bằng dấu gạch dưới.
- Tên biến static và final nên mô tả rõ ràng về giá trị mà biến đang đại diện.
Ví dụ: final int MAX_VALUE, static final String DATABASE_URL
Các quy tắc name convention trong Java không chỉ giúp cho code trở nên dễ đọc và dễ hiểu hơn mà còn giúp cho các lập trình viên có thể viết code nhanh hơn, giảm thiểu lỗi chính tả và tăng tính thống nhất trong codebase. Ngoài ra, khi áp dụng các quy tắc này, code của bạn cũng sẽ dễ dàng hơn để bảo trì và phát triển trong tương lai.
