Đồng Bộ Hóa Việc Đặt Tên - Naming Convention

Trong quá trình phát triển và xây dựng ứng dụng, phần mềm, game,... đều phải trải qua những giai đoạn như bảo trì và nâng cấp hệ thống. Đặc biệt với làm việc nhóm, bất kỳ dòng code 1 thành viên trong nhóm viết ra phải có ý nghĩa rõ ràng giúp mọi người trong nhóm có thể dễ dàng đọc hiểu.

Naming Convention là một khái niệm cơ bản nhất tập hợp các thủ tục và quy tắc giúp cho việc lập trình, bảo trì, nâng cấp, phát triển và làm việc nhóm đạt được độ hiệu quả tốt nhất.

Tại sao phải đặt tên theo quy tắc?

Quan sát ví dụ

#include <stdio.h>

int conghaiso(int a, int b){return a + b;}

int sotoancuc1;
int sotoancuc2;

int main()
{
    sotoancuc1 = 5;
    sotoancuc2 = 1;
    printf("ket qua cua 2 so la: %d", conghaiso(sotoancuc1, sotoancuc2);

    while(true);
    return 0;
}

Đoạn code trên là chương trình đơn giản về việc cộng 2 số kiểu int lại và in lên màn hình.

Đối với logic của chương trình trên hoàn toàn đúng, nhưng về mặt thẩm mỹ về tên biến và hàm đều không theo một quy tắc nào và có thể làm lẫn lộn ở hàm conghaiso và biến sotoancuc1/sotoancuc2.

Giả sử đây không phải là 1 chương trình ngắn chỉ đơn giản với vài dòng code mà là hàng trăm file chứa code khác nhau và mỗi file chứa tầm 500 đến 1000 dòng code thì không thể nào mà không nhầm lẫn được với cách đặt tên như thế này.

Để khắc phục tình trạng này có các quy tắc để làm code đẹp hơn.

Ví dụ:

#include <stdio.h>

int congHaiSo(int a, int b)
{
    return a + b;
}

int G_SoToanCuc_1;
int G_SoToanCuc_2;

int main()
{
    G_SoToanCuc_1 = 5;
    G_SoToanCuc_2 = 1;

    printf("Ket qua cua 2 so la: %d", congHaiSo(G_SoToanCuc_1, G_SoToanCuc_2);
    
    while(true);
    return 0;
}

Đặt tên theo quy tắc còn tạo sự chuyên nghiệp và nguyên tắc nhất định, giúp tối ưu thời gian đọc code.

Quy tắc đồng bộ hóa tên đặt

Quy tắc đặt tên

Thống nhất ngôn ngữ

Thay vì tên biến hay tên hàm được đặt 1 cách lộn xộn giữa ngôn ngữ này và ngôn ngữ khác, nên thống nhất 1 ngôn ngữ trong khi đặt tên. Thông dụng nhất là tiếng Anh để dễ dàng đồng bộ hoá.

Đặt tên mang ý nghĩa nhất định

Để giúp quá trình đọc và bảo trì code dễ dàng hơn nên đặt tên biến và hàm mang ý nghĩa rõ ràng.

• Tên hàm thường bắt đầu bằng động từ.
• Tên biến là một danh từ hoặc cụm danh từ.

Function Prototype:

int convert(char* _String);

Giả sử hàm convert dùng để chuyển đổi một chuỗi thành số mặc định chuỗi nhập vào hợp lệ, nên đặt tên hàm và biến có một ý nghĩa để có thể dễ dàng đọc hiểu và bảo trì. Có thể thay đổi như sau:

int convertStringtoInteger(char* _String);