Cách viết ghi chú trong C++

Trong bài này chúng ta sẽ tìm hiểu cách viết ghi chú trong C++, qua đó bạn sẽ biết các tạo ghi chú một dòng và ghi chú trên nhiều dòng.

Hầu hết các ngôn ngữ lập trình đều hỗ trợ chức năng ghi chú (hay còn gọi là comment) nhằm giúp ta diễn giải một số đoạn code nào đó để khi đọc vào có thể hiểu ý nghĩa của chúng.

Giả sử mình và bạn cùng viết một ứng dụng giải phương trình bậc hai, mình viết một đoạn và bạn cũng viết một đoạn nhưng cả hai đều không giải thích gì thì rất khó để hiểu nhau. Vì vậy chúng ta phải sử dụng cú pháp tạo ghi chú trong C++ để mô tả.

Trong C++ hỗ trợ hai loại ghi chú, đó là ghi chú đơn dòng và ghi chú đa dòng. Và trước khi bắt đầu thì bạn phải hiểu quy trình biên dịch mã C++ của trình biên dịch đã nhé.

Bài viết này được đăng tại [free tuts .net]

Quy trình biên dịch của một chương trình C++ như sau: Nó sẽ biên dịch từ trên xuống dưới và từ trái qua phải cho tới khi gặp hàm main. Sau khi gặp hàm main thì nó sẽ biên dịch những đoạn code trong hàm đó. Lúc này nếu hàm main có sử dụng những biến khai báo ở phía dưới nó thì sẽ bị báo lỗi vì những đoạn code đó chưa được biên dịch. Vì vậy tất cả những khai báo đều phải đặt ở trên hàm main.

1. Ghi chú (chú thích) trong C++ là gì?

Chú thích là những đoạn text được dùng để giải thích ý nghĩa của một đoạn code nào đó. Chúng ta thường dùng để ghi lại những lưu ý, giải thích quy trình chạy, ý nghĩa của biến ... để sau này khi xem lại sẽ dễ hiểu hơn.

Khi trình biên dịch gặp ghi chú thì nó sẽ bỏ qua và không biên dịch những đoạn ghi chú đó, vì vậy sẽ không có lỗi về cú pháp, và bạn thoải mái trong việc viết nội dung trong phạm vi của ghi chú.

Có hai loại ghi chú, thứ nhất là ghi chú đơn trên một dòng, thứ hai là ghi chú đa dòng (tức laf viết ghi chú trên nhiều dòng bằng một cú pháp tạo ghi chú duy nhất).

2. Ghi chú một dòng trong C++

Chúng ta sử dụng hau dấu xoẹt \\ để tạo ghi chú đơn dòng.

Ví dụ: Ghi chú trên một hàng.

#include <iostream>
using namespace std;

int main()
{
	// Khai bao va gan gia tri cho bien tuoi
	int tuoi = 20;
	
	// In gia tri bien tuoi ra man hinh
	cout << tuoi;
	
	retuur 1;
}

Khi chương trình biên dịch nó sẽ bỏ qua dòng bắt đầu tự vị trí hai dấu xoẹt //.

Ví dụ: Ghi chú một đoạn nhỏ trên một hàng

#include <iostream>
using namespace std;

int main()
{
	int tuoi = 20;	// Khai bao va gan gia tri cho bien tuoi
	
	cout << tuoi;	// In gia tri bien tuoi ra man hinh
	
	return 1;
}

3. Ghi chú nhiều dòng trong C++

Ghi chú đa dòng là ghi chú trên nhiều dòng. Chúng ta sử dụng cú pháp sau để tạo ghi chú đa dòng:

/*
Noi dung ghi chu
*/

Bên trong nội dung ghi chú bạn có thể sử dụng bao nhiêu dòng cũng được.

Ví dụ: Ghi chú đa dòng

#include <iostream>
using namespace std;


/*
Day la ham main cua chuong trinh
Ham nay se chay dau tien trong chuong trinh
Cho du ban dat no o vi tri nao
*/
void main()
{
	// Code
}

Ta cũng có thể sử dụng ghi chú đơn dòng nhiều lần để tạo ghi chú đa dòng nhưng như vậy sẽ không đẹp cho lắm.

Ví dụ: Tạo ghi chú đa dòng từ nhiều ghi chú đơn dòng.

#include <iostream>
using namespace std;


// Day la ham main cua chuong trinh
// Ham nay se chay dau tien trong chuong trinh
// Cho du ban dat no o vi tri nao
int main()
{
	// Code
}

Cũng tùy vào thói quen của mỗi người mà chọn cách ghi chú phù hợp.

4. C++ không biên dịch các lệnh trong ghi chú

Để chứng minh là chương trình sẽ không biên dịch lệnh ghi chú thì bạn hãy xem ví dụ sau:

#include <iostream>
using namespace std;

int main()
{
	// cout << "Chao mung ban den voi freetuts.net";
	// cout << "Mot website hoc lap trih mien phi";
        return 1;
}

Chạy chương trình lên bạn sẽ thấy như hình sau:

Kết quả sẽ không có gì => chương trình đã không chạy hai đoạn code cout ở trên.

4. Lời kết

Trong một chương trình có thể lên tới hàng trăm và hàng ngàn dòng code, lúc này nếu bạn không sử dụng ghi chú thì bạn không thể nhớ hết là bạn đã code những gì, chưa tính đến khi bạn làm việc nhóm thì bạn đồng nghiệp sẽ rất khó biết được ý tưởng mà bạn đã code chương trình đó. Vì vậy giải pháp là hãy sử dụng ghi chú nếu có thể nhé.