Những gì nên và những gì không nên có trong một tập tin tiêu đề? [đóng cửa]

Những điều tuyệt đối không bao giờ nên được bao gồm trong một tập tin tiêu đề?

Ví dụ, nếu tôi đang làm việc với một định dạng tiêu chuẩn công nghiệp có nhiều hằng số, thì có phải là một cách thực hành tốt để xác định chúng trong tệp tiêu đề (nếu tôi đang viết một trình phân tích cú pháp cho định dạng đó)?

Những chức năng nào nên đi vào tập tin tiêu đề?
Những chức năng nào không nên?

Những gì cần đặt trong tiêu đề:

• Tập hợp các lệnh tối thiểu #includecần thiết để làm cho tiêu đề có thể biên dịch được khi tiêu đề được bao gồm trong một số tệp nguồn.
• Định nghĩa biểu tượng tiền xử lý của những thứ cần được chia sẻ và chỉ có thể được thực hiện thông qua bộ tiền xử lý. Ngay cả trong C, các ký hiệu tiền xử lý vẫn được giữ ở mức tối thiểu.
• Khai báo chuyển tiếp của các cấu trúc cần thiết để tạo các định nghĩa cấu trúc, nguyên mẫu hàm và khai báo biến toàn cục trong phần thân của tiêu đề có thể biên dịch được.
• Các định nghĩa về cấu trúc dữ liệu và bảng liệt kê được chia sẻ giữa nhiều tệp nguồn.
• Khai báo cho các hàm và các biến có định nghĩa sẽ hiển thị cho trình liên kết.
• Định nghĩa hàm nội tuyến, nhưng hãy cẩn thận ở đây.

Những gì không thuộc về một tiêu đề:

• #includeChỉ thị vô cớ . Những điều vô cớ đó bao gồm việc biên dịch lại những thứ không cần phải biên dịch lại, và đôi khi có thể khiến nó trở thành một hệ thống không thể biên dịch được. Không #includetập tin trong tiêu đề nếu bản thân tiêu đề không cần tập tin tiêu đề khác.
• Các ký hiệu tiền xử lý mà ý định của chúng có thể được thực hiện bằng một số cơ chế, bất kỳ cơ chế nào, ngoài cơ chế tiền xử lý.
• Rất nhiều và rất nhiều định nghĩa cấu trúc. Chia chúng thành các tiêu đề riêng biệt.
• Định nghĩa nội tuyến của các hàm yêu cầu bổ sung #include, có thể thay đổi hoặc quá lớn. Các hàm nội tuyến đó sẽ có rất ít nếu có bất kỳ quạt nào ra ngoài và nếu chúng có quạt ra, thì nó nên được định vị thành các thứ được xác định trong tiêu đề.

Điều gì tạo thành tập hợp tối thiểu của #includebáo cáo?

Điều này hóa ra là một câu hỏi không cần thiết. Định nghĩa TL; DR: Tệp tiêu đề phải bao gồm các tệp tiêu đề xác định trực tiếp từng loại được sử dụng trực tiếp hoặc khai báo trực tiếp từng hàm được sử dụng trong tệp tiêu đề đang đề cập, nhưng không được bao gồm bất kỳ thứ gì khác. Một loại tham chiếu con trỏ hoặc C ++ không đủ điều kiện là sử dụng trực tiếp; tài liệu tham khảo về phía trước được ưa thích.

Có một nơi cho một #includechỉ thị vô cớ , và đây là một thử nghiệm tự động. Đối với mỗi tệp tiêu đề trong gói phần mềm, tôi sẽ tự động tạo và sau đó biên dịch các mục sau:

#include "path/to/random/header_under_test"
int main () { return 0; }

Việc biên dịch phải sạch sẽ (nghĩa là không có bất kỳ cảnh báo hay lỗi nào). Các cảnh báo hoặc lỗi liên quan đến các loại không đầy đủ hoặc các loại không xác định có nghĩa là tệp tiêu đề được kiểm tra có một số #includechỉ thị bị thiếu và / hoặc thiếu các khai báo chuyển tiếp. Lưu ý rõ: Chỉ vì bài kiểm tra vượt qua không có nghĩa là tập hợp các #includechỉ thị là đủ, chứ đừng nói là tối thiểu.

Ngoài những gì đã được nói.

Các tệp H phải luôn chứa:

• Tài liệu mã nguồn !!! Ở mức tối thiểu, mục đích của các tham số khác nhau và giá trị trả về của các hàm là gì.
• Bảo vệ tiêu đề, #ifndef MYHEADER_H #define MYHEADER_H ... #endif

Không bao giờ chứa tệp H:

• Bất kỳ hình thức phân bổ dữ liệu.
• Định nghĩa hàm. Hàm nội tuyến có thể là một ngoại lệ hiếm trong một số trường hợp.
• Bất cứ điều gì được dán nhãn static.
• Typedefs, #defines hoặc hằng số không liên quan đến phần còn lại của ứng dụng.

(Tôi cũng sẽ nói rằng không bao giờ có bất kỳ lý do nào để sử dụng các biến toàn cục / bên ngoài không đổi, ở bất cứ đâu, nhưng đó là một cuộc thảo luận cho một bài đăng khác.)

Tôi có lẽ sẽ không bao giờ nói không bao giờ, nhưng các câu lệnh tạo dữ liệu và mã khi chúng được phân tích cú pháp không nên nằm trong tệp .h.

Macro, hàm và mẫu nội tuyến có thể trông giống như dữ liệu hoặc mã, nhưng chúng không tạo mã khi chúng được phân tích cú pháp, mà thay vào đó khi chúng được sử dụng. Các mục này thường cần được sử dụng trong nhiều .c hoặc .cpp, vì vậy chúng thuộc về .h.

Theo quan điểm của tôi, một tệp tiêu đề nên có giao diện thực tế tối thiểu với .c hoặc .cpp tương ứng. Giao diện có thể bao gồm #defines, class, typedef, định nghĩa cấu trúc, nguyên mẫu hàm và các định nghĩa bên ngoài ít được ưa thích hơn cho các biến toàn cục. Tuy nhiên, nếu một khai báo chỉ được sử dụng trong một tệp nguồn, thì có lẽ nên loại trừ nó khỏi .h và được chứa trong tệp nguồn thay thế.

Một số có thể không đồng ý, nhưng tiêu chí cá nhân của tôi đối với các tệp .h là chúng # bao gồm tất cả các tệp .h khác mà chúng cần để có thể biên dịch. Trong một số trường hợp, đây có thể là rất nhiều tệp, vì vậy chúng tôi có một số phương pháp hiệu quả để giảm sự phụ thuộc bên ngoài như khai báo chuyển tiếp đến các lớp cho phép chúng tôi sử dụng con trỏ tới các đối tượng của lớp mà không bao gồm những gì có thể là một cây bao gồm các tệp lớn.

Tập tin tiêu đề nên có tổ chức sau:

• định nghĩa kiểu và hằng
• khai báo đối tượng bên ngoài
• khai báo hàm ngoài

Các tệp tiêu đề không bao giờ nên chứa các định nghĩa đối tượng, chỉ các định nghĩa kiểu và khai báo đối tượng.

Các câu lệnh tạo dữ liệu và mã khi chúng được phân tích cú pháp, không nên có trong một .htệp. Theo quan điểm của tôi, một tệp tiêu đề chỉ nên có giao diện thực tế tối thiểu tương ứng .choặc .cpp.