Tôi đang tìm một "phương pháp hay nhất" để ghi lại mã C của mình. Giống như trong bất kỳ dự án nào, tôi có một số tệp tiêu đề ".h" và tệp nguồn tương ứng ".c"Nhận xét các mã C, tiêu đề và các tệp nguồn
Trong tệp tiêu đề bạn đưa vào loại nhận xét nào? Và trong các tệp nguồn? Câu hỏi nảy sinh bởi vì vì tôi cũng nhận xét các tệp tiêu đề của tôi nên các tệp c trông giống như một mớ hỗn độn.
Thực tiễn tốt nhất của bạn trong việc giữ mã được nhận xét là gì?
Tiêu đề có nghĩa là đối với người dùng của mã. Vì vậy, trong đó tôi ghi lại giao diện : cách sử dụng nó, điều kiện tiên quyết và postconditions, v.v.
Tệp .c dành cho người duy trì. Ở đó, tôi ghi lại việc thực hiện : cách mọi thứ hoạt động bên trong và tại sao chúng hoạt động theo cách đó.
Tôi sẽ nói rằng 'Tiêu đề có nghĩa là cho người dùng mã và cũng cho người bảo trì ' –
Nếu đây là một dự án cá nhân tôi đề nghị có rất nhiều coding standards ngoài đó bạn có thể áp dụng (hầu như tất cả đều bao gồm các phần về cách đưa ra nhận xét).
Nếu không, tôi sẽ tưởng tượng công ty/dự án/dự án của bạn đã có sẵn một thứ gì đó để sử dụng.
Đối với tệp nguồn Tôi đề nghị bạn tạo mẫu nhận xét cho Tiêu đề tệp và Tiêu đề chức năng.
Trong trường hợp nhận xét tiêu đề tệp, bạn nên có mô tả ngắn gọn về tệp, tên hàm, tác giả, ngày tạo và lịch sử để ghi sửa đổi.
Trường hợp tiêu đề hàm, bạn có thể giải thích logic và mục đích của hàm và các tham số khác nhau. Hãy đảm bảo rằng bất kỳ logic phức tạp hoặc độ lệch nào từ hành vi thông thường cũng được ghi lại thông qua các nhận xét.
Chắc chắn đã nhận xét tiêu đề của bạn tốt là không có lý do cho các tập tin c là một mớ hỗn độn ... –
Một câu hỏi tương tự có thể được tìm thấy ở đây: http://stackoverflow.com/questions/487114/cc-header-file- tài liệu – mouviciel