Chú thích (Comments)
Chú thích (comment) là phần văn bản trong code mà trình biên dịch bỏ qua, dùng để giải thích code cho người đọc.
1. Chú thích một dòng
Phần tiêu đề “1. Chú thích một dòng”Dùng // trước nội dung cần ghi chú:
// Đây là chú thích một dòngint age = 25; // Chú thích ở cuối dòng code2. Chú thích nhiều dòng
Phần tiêu đề “2. Chú thích nhiều dòng”Dùng cặp /* ... */ để bao quanh nội dung ghi chú trải dài nhiều dòng:
/*Đây là chú thíchtrải dài trênnhiều dòng*/int score = 100;⚠️ Chú thích nhiều dòng không thể lồng nhau:
/* /* Lồng comment sẽ gây lỗi biên dịch */*/3. Dùng comment để “tắt tạm” một đoạn code
Phần tiêu đề “3. Dùng comment để “tắt tạm” một đoạn code”Comment thường được dùng để tạm vô hiệu hóa một dòng code khi debug:
int a = 5;// int b = 10; // Tạm thời không dùng dòng nàystd::cout << a << std::endl;4. Documentation comment
Phần tiêu đề “4. Documentation comment”Nhiều dự án dùng comment theo định dạng đặc biệt để công cụ như Doxygen tự sinh tài liệu:
/** * Tính tổng hai số nguyên. * @param a Số thứ nhất * @param b Số thứ hai * @return Tổng của a và b */int sum(int a, int b) { return a + b;}Tổng kết
Phần tiêu đề “Tổng kết”//cho chú thích một dòng/* ... */cho chú thích nhiều dòng- Chú thích nhiều dòng không được lồng nhau
- Nên viết chú thích giải thích tại sao làm vậy, không phải làm gì (code đã tự nói lên điều đó)