Quy tắc về đặt tên biến, tên hàm trong lập trình

Việc viết code sạch và tuân thủ quy tắc đặt tên hàm, biến, và các quy tắc khác là rất quan trọng để làm cho mã nguồn dễ đọc, dễ hiểu và dễ bảo trì. Dưới đây là một số quy tắc quan trọng khi viết mã nguồn:

Quy tắc đặt tên:

1. Sử dụng tên mô tả rõ ràng:

   • Đặt tên sao cho người đọc có thể hiểu được chức năng của biến hoặc hàm mà không cần phải xem mã nguồn.

2. Sử dụng tiếng Anh và không viết tắt quá mức:

   • Hãy sử dụng tiếng Anh để đặt tên biến, hàm và các phần khác của mã nguồn để giữ cho mã dễ đọc bởi mọi người. Tránh sử dụng viết tắt không rõ ràng.

3. Chia rõ các từ và sử dụng phong cách CamelCase hoặc snake_case:

   • CamelCase (tức là viết hoa chữ cái đầu của mỗi từ) thích hợp cho tên lớp hoặc hàm, ví dụ: calculateTotalPrice().

   • snake_case (tức là sử dụng dấu gạch dưới _ để ngăn cách các từ) thích hợp cho tên biến, ví dụ: total_price.

Quy tắc về cú pháp và cấu trúc mã nguồn:

1. Indentation (Thụt đầu dòng):

   • Sử dụng cùng một lựa chọn thụt đầu dòng trong toàn bộ mã nguồn (thường là 2 hoặc 4 khoảng trắng).

2. Khoảng trắng và dòng trống:

   • Sử dụng khoảng trắng để phân cách các phần khác nhau của mã nguồn để làm cho mã dễ đọc hơn.

   • Sử dụng dòng trống để phân cách các phần khác nhau của chương trình (ví dụ: giữa các hàm, giữa các khối if-else, …).

3. Tránh dòng code quá dài:

   • Hãy cố gắng giới hạn độ dài của mỗi dòng code để mã nguồn dễ đọc.

4. Đặt các hàm và biến liên quan gần nhau:

   • Cố gắng đặt các biến và hàm mà liên quan đến nhau gần nhau để dễ theo dõi.

Quy tắc về cách viết mã:

1. Tránh sử dụng biến toàn cục (global variables):

   • Ưu tiên sử dụng biến cục bộ trong hàm và truyền tham số khi cần thiết.

2. Chia nhỏ hàm:

   • Mỗi hàm nên chỉ thực hiện một nhiệm vụ cụ thể. Hãy cố gắng giữ cho hàm ngắn gọn và dễ đọc.

3. Sử dụng comment một cách hợp lý:

   • Sử dụng comment để giải thích những đoạn mã phức tạp hoặc có logic khó hiểu.

4. Sử dụng kiểm thử và gỡ lỗi:

   • Kiểm tra và sửa lỗi trong mã của bạn để đảm bảo rằng nó hoạt động đúng.

5. Tuân thủ các nguyên tắc thiết kế và kiến trúc phần mềm:

   • Cố gắng tuân thủ các nguyên tắc như SOLID, DRY (Don’t Repeat Yourself), KISS (Keep It Simple, Stupid),…

Lưu ý rằng các quy tắc trên chỉ là một số nguyên tắc cơ bản. Tùy thuộc vào ngôn ngữ lập trình và dự án cụ thể, có thể có các quy tắc khác áp dụng. Điều quan trọng là duy trì một mã nguồn dễ đọc, dễ hiểu và dễ bảo trì.

Detals

1. Quy tắc đặt tên biến (Variable Naming Conventions):

• Sử dụng tiếng Anh và tránh viết tắt không cần thiết.

• Sử dụng hình thức camelCase hoặc snake_case.

  • camelCase: Bắt đầu bằng chữ thường và các từ tiếp theo bắt đầu bằng chữ in hoa (ví dụ: totalPrice, numberOfItems).

  • snake_case: Sử dụng dấu gạch dưới để ngăn cách các từ (ví dụ: total_price, number_of_items).

• Đặt tên biến sao cho rõ ràng, mô tả chức năng hoặc giá trị mà biến đó đang lưu trữ.

2. Quy tắc đặt tên hàm (Function Naming Conventions):

• Sử dụng tiếng Anh và tránh viết tắt không cần thiết.

• Sử dụng hình thức camelCase hoặc snake_case tùy thuộc vào quy ước của ngôn ngữ lập trình.

• Đặt tên hàm phản ánh chức năng mà hàm đó thực hiện.

3. Quy tắc đặt tên class (Class Naming Conventions):

• Sử dụng tiếng Anh và tránh viết tắt không cần thiết.

• Sử dụng hình thức CamelCase và đặt tên class phải rõ ràng, mô tả được chức năng hoặc mục đích của class đó.

4. Quy tắc đặt tên hằng số (Constant Naming Conventions):

• Đặt tên hằng số bằng chữ in hoa và sử dụng dấu gạch dưới để ngăn cách các từ (ví dụ: MAX_VALUE, PI).

5. Quy tắc đặt tên module hoặc gói (Module/Package Naming Conventions):

• Sử dụng tên ngắn gọn, nhưng rõ ràng về mục tiêu hoặc chức năng của module hoặc gói.

• Tránh sử dụng các ký tự đặc biệt.

6. Quy tắc đặt tên cho biến toàn cục (Global Variable Naming Conventions):

• Sử dụng tiếng Anh và đảm bảo rõ ràng về mục đích và chức năng của biến toàn cục.

7. Sử dụng tên mô tả rõ ràng:

• Tên biến, hàm, class, và các thành phần khác của mã nguồn nên phản ánh rõ ràng chức năng của chúng.

8. Tránh sử dụng từ khóa đã được định nghĩa trong ngôn ngữ:

• Không sử dụng tên đã được sử dụng cho từ khóa, class hoặc thư viện tiêu chuẩn trong ngôn ngữ.

Lưu ý:

• Các ngôn ngữ cụ thể có thể có quy tắc đặt tên riêng biệt, vì vậy hãy tìm hiểu về quy ước đặt tên của ngôn ngữ mà bạn đang sử dụng.

Ví dụ (Python):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Biến
total_price = 100
number_of_items = 5

# Hàm
def calculate_total_price(price, quantity):
    return price * quantity

# Class
class ShoppingCart:
    def __init__(self):
        self.items = []

    def add_item(self, item):
        self.items.append(item)

# Hằng số
MAX_VALUE = 1000
PI = 3.14

Kết luận:

Tuân thủ các quy tắc đặt tên giúp mã nguồn của bạn dễ đọc, dễ hiểu và dễ bảo trì, đồng thời giúp tăng tính nhất quán và sự hợp tác khi làm việc trong nhóm.

Ref

Internet

Hết.

• Previous
  Một số câu hỏi và giải đáp khi huấn luyện mô hình với deep learning
• Next
  Create chatGPT for your university