Hướng Dẫn Đặt Tên Trong Lập Trình: Quy Tắc và Thực Hành Tốt

1. Đặt Tên Cho Class

Khi đặt tên cho Class, nhiều lập trình viên thường mắc phải các lỗi như: tên quá chung chung, không rõ nghĩa, và chưa phản ánh đúng chức năng của nó. Để khắc phục, dưới đây là một số quy tắc cơ bản:

• Sử dụng danh từ: Tên của Class nên là danh từ để phản ánh đúng mục đích.
• Cụ thể hóa tên: Tránh các tên mông lung hoặc tối nghĩa.
• Đảm bảo nguyên tắc Single Responsibility: Mỗi Class chỉ nên đảm nhận một nhiệm vụ cụ thể.
• Tránh hậu tố chung: Hạn chế việc sử dụng hậu tố mơ hồ như “Manager”, “Helper”,...

Ví dụ:

2. Đặt Tên Cho Method

Method là các phương thức bên trong Class. Tên của phương thức rất quan trọng vì:

1. Tên không rõ ràng sẽ khiến người đọc phải xem toàn bộ Class trước khi hiểu nó thực hiện điều gì.
2. Thiếu tên mô tả khiến người đọc không nắm bắt được logic bên trong.

Ví dụ:

Lưu ý:

• Đặt tên phương thức nên rõ ràng để người đọc hiểu chính xác chức năng mà không cần phải xem mã nguồn.
• Giữa tên Class và tên các Method nên có sự tương liên.

3. Kỹ Thuật Rubber Ducking

Rubber Ducking là một phương pháp giúp bạn phát triển khả năng đặt tên hiệu quả. Bằng cách giải thích mã mà bạn định viết cho một cái gì đó như một chú vịt cao su, bạn sẽ có khả năng làm rõ ý tưởng và vấn đề của mình hơn.

• Giải thích mã cho chú vịt cao su này sẽ thúc đẩy bạn tư duy và giúp bạn tìm ra những cái tên thích hợp.

4. Dấu Hiệu Cảnh Báo

Nếu bạn thấy các từ như And, Or, If trong tên Class hoặc Method, đó là dấu hiệu cho thấy chúng đang làm quá nhiều việc.

Ví dụ:

• SenEmailAndUploadFile() không nên là một Method, thay vào đó hãy tách ra thành hai Method khác nhau.

5. Tác Dụng Phụ

Tên của Class/Method phải rõ ràng và không gây ra tác dụng phụ không mong muốn.

Ví dụ:

• Nếu bạn có một method tên là CheckPassword nhưng lại logout user trong mã nguồn, điều đó là không tốt.

6. Sử Dụng Viết Tắt

Nên tránh sử dụng viết tắt trong tên Class/Method. Chúng có thể gây khó khăn trong việc hiểu mã nguồn. Thay vì sử dụng tên như RegUsr, tốt hơn là sử dụng RegisterUser.

7. Đặt Tên Biến: Biến Boolean

Khi đặt tên cho biến Boolean, hãy đảm bảo chúng nghe giống như một câu hỏi. Ví dụ:

8. Đặt Tên Biến: Đảm Bảo Tính Đối Xứng

Hãy đảm bảo rằng tên của các biến có tính đối xứng và thống nhất với nhau:

9. Đặt Tên Biến: Không Lặp Lại Ngữ Cảnh Không Cần Thiết

Khi tên Class/Object đã cho bạn thông tin, không cần lặp lại điều đó trong tên biến:

Ví dụ:

Car car = Car(
  carMake: "Huyndai",
  carModel: "i10",
  carColor: "White"
);

public void PaintCar(Car car, Color color) {
  car.color = color;
}

Kết Luận

Việc đặt tên đúng không chỉ giúp mã nguồn trở nên dễ đọc hơn mà còn tăng cường khả năng bảo trì và hiểu biết cho những lập trình viên khác. Hy vọng các quy tắc trên sẽ giúp bạn cải thiện kỹ năng lập trình của mình! Cảm ơn bạn đã theo dõi bài viết!

source: viblo