Lập trình C++ Basic | #5. Chú thích trong C++

Chương 2: CÁC KHÁI NIỆM CƠ BẢN TRONG C++

2.3 Cú pháp của chú thích (comment) trong C++

Trong lập trình, Comment là một dòng hoặc nhiều dòng văn bản, được chèn vào source code chương trình, nhằm làm cho source code trở nên dễ hiểu hơn với người đọc, được bỏ qua bởi compiler và interpreter. Trong C++, có 2 loại comment:

2.3.a. Ký hiệu: //: dùng cho comment 1 dòng. Với loại comment này, compiler sẽ bỏ qua mọi thứ từ ký hiệu // đến cuối dòng. Ví dụ:

• Những bình comment này được dùng để giải thích cho 1 dòng code

cout << "Hello World!" << endl; // Mọi thứ bên phải ký hiệu này đều bị bỏ qua

cout << "Duy Tan University!" << endl; // Dùng để giải thích cho dòng code này

cout << "Nice to meet you!" << endl; // Hạn chế comment theo cách này

cout << "Hello PNU CS211!" << endl; // Đặc biệt với dòng code dài

• Thông thường, comment // bên phải dòng code là không được khuyến khích, vì nó sẽ gây khó đọc cho cả code và comment của bạn, đặc biệt đối với những dòng code dài. Vì vậy, comment // thường được đặt phía trên của dòng code cần giải thích. Ví dụ:

// Mọi thứ bên phải ký hiệu này đều bị bỏ qua

cout << "Hello World!" << endl;

// Dùng để giải thích cho dòng code này

cout << "Duy Tan University!" << endl;

// Không nên comment theo cách này

cout << "Nice to meet you!" << endl;

// Đặc biệt với dòng code dài

cout << "Hello PNU CS211!" << endl;

2.3.b. Ký hiệu: /* và */: dùng cho comment nhiều dòng. Với loại comment này, compiler sẽ bỏ qua mọi thứ ở giữa ký hiệu /* và */. Ví dụ:

• Đây là comment nhiều dòng đơn giản:

/*

Đây là comment nhiều dòng

Mọi thứ bên trong ký hiệu này sẽ được bỏ qua

Bạn có thể viết cả bài văn vào đây...

*/

• Bạn có thể comment giữa dòng code của bạn. Ví dụ:

return /* Bỏ qua mọi thứ trong này */ 0;

• Hoặc bạn cũng có thể làm cho comment đẹp hơn bằng cách:

/*

 * Đây là comment nhiều dòng

 * Mọi thứ bên trong ký hiệu này sẽ được bỏ qua

 * Bạn có thể viết cả bài văn vào đây...

 */

2.3.c. Quy tắc: comment nhiều dòng không được lồng nhau. Ví dụ:

/* Đây là comment cha /* comment con */ lỗi rồi */

// Comment 1 dòng /* comment nhiều dòng */ vẫn là comment

2.4 Mộ số kinh nghiệm comment trong lập trình

Bạn đã nắm được các loại comment trong C++. Nhưng mới chỉ nắm được cú pháp không thôi vẫn chưa đủ, bạn cần phải biết sử dụng nó như thế nào cho hợp lý. Dưới đây là một số kinh nghiệm khi comment trong lập trình:

2.4.a. Ở mức library, program hoặc function, một good comment sẽ mô tả được library, program hoặc function đó có nhiệm vụ gì:

//************************************

// Description: Thư viện này khai báo các standard input/output stream objects (iostream)

//************************************

#include <iostream>

//************************************

// Description: Chương trình tính thời gian xây được nhà dựa vào nơi bạn sống và ngành nghề của bạn

//************************************

double TinhThoiGianXayNha(string address, string job)

//************************************

// Description: Hàm sắp xếp mảng bằng thuật toán quick sort.

//************************************

void QuickSort(int * arr, int left, int right)

Những comment như trên sẽ giúp người khác nhanh chóng hiểu được một library, program hoặc function đó có mục đích gì, mà không cần phải nhìn vào những đoạn code của nó. Thông thường, những comment ở mức library có thể nằm trong file readme.txt, hoặc trên main function đối với một program.

2.4.b. Bên trong library, program hoặc function, một good comment sẽ mô tả được library, program hoặc function đó thực hiện như thế nào:

void QuickSort(int * arr, int left, int right)

{

//////////////////////////////////////////////////////////////////////////

//

// Để sắp sếp bằng thuật toán quick sort, hàm thực hiện theo các bước bên dưới:

// 1. Tìm một giá trị trục

// 2. Di chuyển tất cả phần tử lớn hơn hoặc bằng giá trị trục sang phải

// 3. Di chuyển tất cả phần tử nhỏ hơn giá trị trục sang trái

// 4. Sắp sếp đệ quy cho 2 mảng con bên trái và bên phải

//

//////////////////////////////////////////////////////////////////////////

// code here...

}

2.4.c. Commenting out code

Comment không chỉ dừng ở mục đích giải thích đoạn code của bạn. Đôi khi bạn sẽ gặp vài tình huống như:

• Bạn đang cần chạy một chương trình, và có vài dòng code trong chương trình của bạn đang gặp lỗi nên compiler không cho phép. Nhưng bạn muốn chạy chương trình ngay.
• Bạn đang nâng cấp một đoạn code, bạn muốn giữ đoạn code cũ để tham khảo cho đến khi đoạn code mới của bạn hoàn thành. Hoặc để phục hồi lại đoạn code cũ nếu đoạn code mới của bạn chạy gặp vấn đề.

Khi gặp những tình huống này, bạn có thể dùng comment out code, mọi đoạn code mà bạn comment sẽ được bỏ qua bởi compiler. Ví dụ:

// const int n = 69;

// cout << "Hello Duy Tan Univetsity!" << endl;