Dùng các vĩ lệnh một cách hiệu quả ở C để phục hồi sức khỏe và bảo trì

Viết các vĩ châm trắng: Cách thực hành tốt nhất

Sự linh hoạt của vĩ mô cũng là mối nguy hiểm của chúng. một vĩ mô không được viết dở có thể gây ra những hành vi bất ngờ khó để theo dõi. theo những cách tốt nhất để giữ cho vĩ mô của bạn an toàn và có thể bảo tồn.

Luôn luôn phân tích tham số và biểu thức toàn bộ

Vì vĩ mô là văn bản thay thế, người điều hành có thể phá vỡ chúng. Một vĩ mô như sẽ mở rộng [FLT: 9) (có nghĩa là 11 không phải 25). Việc sửa đổi là gửi kèm mỗi tham số trong ngoặc và gói toàn bộ biểu thức:

#define SQUARE(x) ((x) * (x)) // now SQUARE(3+2) works correctly

Tránh nhiều đánh giá những cuộc tranh cãi

Đối số Macro được thay thế như-is. Nếu một đối số có tác dụng phụ (v., , nó có thể được đánh giá nhiều hơn một lần. Ví dụ:

#define MAX(a,b) ((a) > (b) ? (a) : (b))
int x = 5;
int max = MAX(x++, 10); // expands to ((x++) > (10) ? (x++) : (10)) // x incremented twice!

Để tránh điều này, hãy chọn chức năng trực tiếp hoặc dùng các đại hội tên một cách cẩn thận để cảnh báo người dùng. Nếu bạn cần phải dùng vĩ mô, tài liệu không nên chứa tác dụng phụ.

Dùng chữ trên cho các tên vĩ lệnh

Theo hội nghị, vĩ mô được viết bằng chữ hoa (v. d., , .

Kết thúc Macro với « Do- in » cho khối đa phân

Khi xác định một vĩ mô chứa nhiều lời tuyên bố, hãy quấn chúng trong vòng . Điều này đảm bảo vĩ mô ứng xử đúng trong mọi ngữ cảnh (v. d., sau khi không có dây chằng):

#define LOG_ERROR(msg) do { \
 fprintf(stderr, "Error: %s\n", msg); \
 exit(1); \
} while (0)

Tài liệu vĩ lệnh một cách hoàn hảo

Các vĩ lệnh thiếu tự thống kê các chức năng. Luôn luôn thêm các bình luận mô tả các đối số, mong đợi hành vi và bất kỳ giới hạn nào. Dùng bình luận kiểu Doxygen khi thích hợp.

Công nghệ vĩ mô vĩ mô cao cấp

Các bộ xử lý C cung cấp các nhà điều hành mạnh mẽ mà đi xa hơn so với thay thế đơn giản. làm chủ những thứ này có thể làm cho vĩ mô của bạn còn linh hoạt hơn.

Chuỗi hoá

Người điều khiển biến một đối số vĩ mô thành một chuỗi theo nghĩa đen. Điều này có ích cho việc gỡ lỗi hoặc ghi nhật ký:

#define PRINT_VAR(x) printf(#x " = %d\n", x)
int value = 42;
PRINT_VAR(value); // prints: value = 42

Token Pasting với

Người điều khiển phân loại hai vật thể thành một vật thể riêng lẻ. Tính năng này cho phép bạn tạo bộ nhận diện động theo thời gian biên dịch:

#define CREATE_VAR(prefix, index) prefix ## index
int CREATE_VAR(arr, 0) = 10; // becomes int arr0 = 10;

Việc dán ảnh được sử dụng rộng rãi trong X vĩ mô và để tạo ra các mẫu mã lặp lại.

Đa thức vĩ lệnh (C99)

Giới thiệu trong C99, vĩ mô biến số chấp nhận một số biến số dùng . Điều này cho phép ghi nhật ký linh hoạt và gỡ lỗi vĩ mô:

#define DEBUG_PRINT(fmt, ...) \
 fprintf(stderr, "DEBUG: " fmt, __VA_ARGS__)
DEBUG_PRINT("x = %d, y = %d", x, y);

Trong C11 và sau đó, bạn có thể dùng để xử lý dấu phẩy trong các lý luận rỗng, cải thiện khả năng chuyển tiếp.

Những cạm bẫy thông thường và cách tránh chúng

Thậm chí những nhà phát triển có kinh nghiệm C cũng gặp những con bọ có liên quan đến vĩ mô.

• Một vĩ mô mở rộng đến một khối mà không có dấu chấm phẩy có thể gây ra lỗi cú pháp.
• Người giải thích bất ngờ [FLT: 1]: luôn luôn chấp nhận [như đã ghi trên.
• Nếu bạn định nghĩa vĩ mô với cùng tên với một chức năng thư viện chuẩn, nó có thể âm thầm ghi đè lên nó. Dùng tên độc nhất hoặc #undef.
• Không-constant fFLT bản [FLT: 1]]: các vĩ mô vật thể được sử dụng như hằng số, nhưng không được gõ. Chúng có thể được sử dụng trong các biểu thức liên tục chỉ nếu chính sự mở rộng là một biểu thức thường xuyên.
• Khó khăn giảm dần ): Macros được mở rộng trước khi biên dịch thấy chúng, nên thông điệp lỗi chỉ đến mã mở rộng, chứ không phải tên vĩ mô. Việc dùng cờ với GCC hoặc Clang (v. g., cho thấy kết quả trước khi có dấu vết.

static inline int square(int x) {
 return x * x;
}

#ifdef DEBUG
 #define LOG(fmt, ...) fprintf(stderr, "[DEBUG] " fmt, ##__VA_ARGS__)
#else
 #define LOG(fmt, ...) /* no-op */
#endif

#if defined(_WIN32) || defined(_WIN64)
 #define PLATFORM "Windows"
#elif defined(__linux__)
 #define PLATFORM "Linux"
#else
 #define PLATFORM "Unknown"
#endif