Comments - Viết tài liệu tham khảo trong khi viết code Arduino

Giới thiệu

Bạn rất khó ghi nhớ từng dòng code một trong một chương trình thật là dài, với những thuật toán phức tạp, vì vậy Arduino đã làm cho bạn một cú pháp để giải quyết vấn đề này, đó là Comments. Comments sẽ giúp bạn ghi chú cho từng dòng code hoặc trình bày nhiệm vụ của nó để bạn hoặc những người khác có thể hiểu được chương trình này làm được những gì. Và comments sẽ không được Arduino biên dịch nên cho dù bạn viết nó dài đến đâu thì cũng không ảnh hưởng đến bộ nhớ flash của vi điều khiển. Để comments trong Arduino, bạn có 2 cách.

Ví dụ

 x = 5;  // Đây là kiểu "single line comment", để làm được điều này, bạn gõ "//"
         // nó sẽ ghi chú tất cả những chữ (text, câu lệnh,... everything) nằm sau dấu // cho đến khi hết dòng

/* Còn đây là "multiline comment" - Bạn bắt đầu ghi chú với ký tự kia.
Nó sẽ "ghi chú" tất cả những gì nằm trong cặp dấu "/ *" và "* /" ( không có dấu cách nhé)
if (gwb == 0){   // ngoài ra bạn có thể dùng single line trong này.
x = 3;           /* nhưng dùng một multiline comment khác thì sẽ bị lỗi cú pháp ngay */
}
// và đừng bao giờ quên ký tự đóng "* /" (ko có dấu cách) nhé!
*/

Gợi ý

Bạn sẽ dùng "single line comment" khi bạn cần ghi chú một đoạn code, ví dụ như ghi cách hiểu nó, nó trả về cái gì,..

Bạn sẽ dùng "multiline comment" để debug. Khi bạn thêm một đoạn code mới vô và cô tình làm cho chương trình hoạt động lỗi thì bạn hãy thử dùng multiline comment để đánh dấu là ghi chú những dòng đó (chương trình dịch sẽ bỏ qua). Sau đó, bạn xem thử chương trình có chạy đúng hay không, nếu có lỗi thì mở rộng single line comment lên những dòng code trước đó nữa, còn nếu không thì bạn thu hẹp multiline comment lại và tiếp tục thực hiện những gì tôi vừa ghi!