Định dạng mã (clang-format)

Trong một nhóm, mỗi người một kiểu thụt lề/đặt ngoặc → code rối, diff đầy thay đổi khoảng trắng vô nghĩa, và những cuộc tranh cãi style vô tận. Giải pháp: một trình định dạng tự động áp cùng một quy tắc cho tất cả - không ai phải nghĩ về style nữa.

• ▸Đọc dễ: mọi file trông như một người viết.
• ▸Diff sạch: review chỉ thấy thay đổi thật, không phải khoảng trắng.
• ▸Hết tranh cãi: máy quyết định style, con người lo logic.

clang-format là trình định dạng C/C++ phổ biến nhất. Nó chỉ lo phần trình bày; việc bắt lỗi tiềm ẩn là phần của phân tích tĩnh (clang-tidy). Đặt một file .clang-format ở gốc dự án để mô tả style chung:

# Bat dau tu mot preset, roi tinh chinh:
BasedOnStyle: LLVM
IndentWidth: 4
UseTab: Never
ColumnLimit: 100
PointerAlignment: Right          # int *p
AllowShortIfStatementsOnASingleLine: false
SortIncludes: true

• ▸BasedOnStyle: LLVM/Google/Mozilla/WebKit/GNU/Microsoft - chọn một làm gốc.
• ▸Override vài tuỳ chọn cho hợp ý team (thụt lề, độ rộng cột, căn con trỏ).
• ▸.clang-format ở gốc dự án; clang-format tự tìm lên cây thư mục.

Chỉnh vài tuỳ chọn (như các dòng trong .clang-format) và xem mã lộn xộn được định dạng lại tức thì:

int main(void) {
int x = 5;
int* p = &x;
  if (x > 0) {
      *p = x + 1;
return *p;
  }
return 0;
}

int main(void) {
    int x = 5;
    int *p = &x;
    if (x > 0) {
        *p = x + 1;
        return *p;
    }
    return 0;
}

Đừng định dạng bằng tay - để công cụ làm ở mọi khâu, từ lúc gõ code, lúc commit, tới lúc CI tự động:

clang-format -i main.c util.c        # dinh dang TAI CHO (ghi de file)
clang-format --dry-run --Werror *.c  # CI: bao loi neu chua dung dinh dang
clang-format --style=file main.c     # dung file .clang-format o du an

• ▸Editor: bật “format on save” (VS Code, vim, CLion…) - format khi lưu.
• ▸Git: pre-commit hook hoặc git-clang-format để format phần thay đổi.
• ▸CI: clang-format --dry-run --Werror chặn code chưa định dạng.

Vài điều để clang-format giúp bạn thay vì gây vướng - định dạng nhất quán là cổng đầu tiên trong sáu cổng chất lượng của dự án xuất xưởng:

// clang-format off
int bang[3][3] = {
    {1, 0, 0},
    {0, 1, 0},     // can cot bang tay -> giu nguyen
    {0, 0, 1},
};
// clang-format on

$ unzip 05-clang-format.zip && cd 05-clang-format   # tai zip bang nut o tren
$ clang-format messy.c            # xem ket qua (chua ghi)
$ clang-format --dry-run --Werror messy.c   # kiem tra kieu CI -> bao loi
$ clang-format -i messy.c         # dinh dang tai cho
$ git diff messy.c