Cách nào thực tế hơn để nhận xét, khai báo (trong tệp tiêu đề) hoặc định nghĩa (trong tệp nguồn)? Có lẽ tôi nên bình luận cả hai, hoặc không bình luận và đặt tất cả trong một tệp riêng biệt ...Tôi có nên nhận xét khai báo hoặc định nghĩa trong C++ không?
Bạn hoàn toàn nên ghi lại tệp tiêu đề có mức độ ưu tiên cao nhất.
Nhận xét trong định nghĩa phải được tập trung vào chi tiết triển khai, trong khi nhận xét tiêu đề phải được tập trung vào giao diện.
Nguồn tài liệu thứ ba, như bạn đã đề xuất, cũng hữu ích. Nó nên mô tả khái niệm tổng thể.
Một cộng lớn các tệp tiêu đề nhận xét là bạn có thể tạo tài liệu tự động từ chúng nếu bạn tuân thủ một số cú pháp đơn giản. Nói xin chào doxygen!
Phụ thuộc vào ý kiến của lời nhận xét và người bạn muốn đọc.
Tôi muốn thêm vào câu trả lời của ypnos:
Nơi nhận xét của bạn tùy thuộc vào người xem của bạn là ai. Suy nghĩ về mã nguồn của bạn như là nguồn đóng giúp trong vấn đề này: người bảo trì có thể thấy được việc triển khai, khách hàng/người dùng chỉ có thể nhìn thấy giao diện. Nếu nhận xét là cần thiết cho người dùng, nó phải đi trong giao diện. Nếu nhận xét chỉ liên quan đến việc triển khai đã cho, có thể chỉ cần đi vào triển khai (nhưng không nhất thiết, tùy thuộc vào đối tượng của bạn).
Tôi không nói câu trả lời được chọn là sai (tôi đồng ý với nó), nhưng tôi không biết làm thế nào ai đó có thể chấp nhận câu trả lời không thực nghiệm bốn phút sau khi yêu cầu. –
Có ý nghĩa với tôi khi tôi đọc nó ... Đó có phải là điểm của trang web này không? Nếu không, thì người hỏi sẽ không thể chọn câu trả lời. –
Chắc chắn, nhưng sau 4 phút, làm cách nào để bạn biết rằng câu trả lời hay hơn hoặc sâu sắc hơn sẽ không xuất hiện. Tôi chỉ thấy nó kỳ lạ, vậy thôi. –