1.3.5 Comment trong source code (1)

Bây giờ chúng ta sẽ nói về việc tạo ra các chú thích (comments) cho chương trình. Các lập trình viên có thể muốn thêm một vài từ không phải cho compiler mà là cho con người, thông thường là để giải thích cho những người khác (khi đọc soure code) các kỹ thuật được sử dụng trong chương trình, hoặc cũng có thể là ý nghĩa của các biến và functions, thậm chí là tên của tác giả cũng như thời điểm chương trình được viết.

Các lập trình viên tốt và có trách nhiệm thì luôn chú thích cho các dòng code quan trọng mới được tạo ra. Đặc biệt, giải thích vai trò của các tham số và các giá trị sửa đổi hoặc giá trị trả về, cũng như giải thích code thực sự đang làm cái vẹo gì, tại sao lại làm thế.

Làm thế nào để chúng ta để lại cái gì đó giống như vậy trong source code? Chúng ta phải làm điều đó theo một cách mà không làm cho compiler biên dịch nó như một phần của source code. Các chú thích được chèn vào chương trình, nó sẽ được bỏ qua trong lúc biên dịch thì được gọi là comment.

Nếu muốn chính xác hơn chúng ta có thể nói rằng về mặt từ vựng thì mỗi comment tương đương với một dấu cách. Bất cứ khi nào compiler gặp một comment trong chương trình của bạn, comment sẽ hoàn toàn trong suốt đối với nó – từ quan điểm này thì comment chỉ là một dấu cách (không quan tâm comment dài bao nhiêu).

C++ hỗ trợ 2 cách để thêm comment:

Một line comment sẽ loại bỏ mọi thứ kể từ cặp dấu gạch chéo (//) cho đến cuối dòng đó.

Trong C++, một block comment (hay còn gọi là comment theo C style) là một văn bản được bắt đầu với một cặp ký tự sau:

Comment có thể dải ra trên nhiều dòng hoặc chỉ xuất hiện trên một hoặc một phần của một dòng.