Khi lập trình trên máy tính, đôi khi cần để lại ghi chú hoặc nhận xét để các nhà phát triển khác có thể duyệt mã của bạn một cách dễ dàng. Cho dù đó là một dự án mã nguồn mở hay một dự án độc quyền, thì cũng cần nhận xét để phối hợp với các nhà đồng phát triển và các nhà phát triển có thể có trong tương lai. Nếu không có bình luận, mã sẽ đơn giản là không thể hiểu được.
Các bước
Bước 1. Hiểu mục đích của việc bình luận một chương trình máy tính
- Khả năng đọc là điều quan trọng ở đây. Khi bạn nhìn vào một bình luận, bạn nên biết rằng đó là một bình luận chứ không phải một dòng mã.
- Nhận xét cũng sẽ hữu ích không chỉ cho bạn mà còn cho bất kỳ ai khác có thể đọc mã nguồn của chương trình máy tính của bạn.
Bước 2. Nghĩ ra một cách ngắn gọn, đơn giản để nói rõ quan điểm của bạn
Nhận xét không cần phải là một tác phẩm nghệ thuật. Chúng phải ngắn gọn, gọn gàng và đi thẳng vào vấn đề.
Tuy nhiên, điều này không khuyến khích việc sử dụng nhiều dòng cho một bình luận. Vấn đề là thông tin cần được truyền đến người đọc
Bước 3. Viết bình luận bằng cú pháp thích hợp mà ngôn ngữ lập trình đưa ra
Bước 4. Tự hỏi bản thân xem nhận xét bạn đã viết có đủ chi tiết hay không
Một nhận xét sẽ có thể cho ai đó đang xem mã nguồn biết phần đó của chương trình thực sự làm gì mà không cần phải biên dịch và chạy nó. Bình luận của bạn có thực hiện được điều này không? Nó có truyền tải được tất cả các chi tiết không?
