Có phải là thực hành tốt để dựa vào các tiêu đề được đưa vào quá cảnh?

Tôi đang dọn dẹp bao gồm trong một dự án C ++ mà tôi đang làm việc và tôi luôn tự hỏi liệu tôi có nên bao gồm rõ ràng tất cả các tiêu đề được sử dụng trực tiếp trong một tệp cụ thể hay không hoặc chỉ nên bao gồm mức tối thiểu.

Đây là một ví dụ , Entity.hpp:

#include "RenderObject.hpp"
#include "Texture.hpp"

struct Entity {
    Texture texture;
    RenderObject render();
}

(Hãy giả sử rằng một tuyên bố chuyển tiếp cho RenderObjectkhông phải là một tùy chọn.)

Bây giờ, tôi biết điều đó RenderObject.hppbao gồm Texture.hpp- tôi biết điều đó bởi vì mỗi người RenderObjectcó một Texturethành viên. Tuy nhiên, tôi rõ ràng bao gồm Texture.hpptrong Entity.hpp, bởi vì tôi không chắc liệu có nên dựa vào nó hay không RenderObject.hpp.

Vậy: Có thực hành tốt hay không?

Bạn phải luôn luôn bao gồm tất cả các tiêu đề xác định bất kỳ đối tượng nào được sử dụng trong tệp .cpp trong tệp đó bất kể bạn biết gì về những gì trong các tệp đó. Bạn nên bao gồm các vệ sĩ trong tất cả các tệp tiêu đề để đảm bảo rằng bao gồm các tiêu đề nhiều lần không thành vấn đề.

Những lý do:

• Điều này cho thấy rõ ràng đối với các nhà phát triển đọc nguồn chính xác những gì tệp nguồn trong câu hỏi yêu cầu. Ở đây, ai đó nhìn vào một vài dòng đầu tiên trong tệp có thể thấy rằng bạn đang xử lý Texturecác đối tượng trong tệp này.
• Điều này tránh các vấn đề trong đó các tiêu đề được cấu trúc lại gây ra các vấn đề biên dịch khi chúng không còn yêu cầu các tiêu đề cụ thể nữa. Ví dụ, giả sử bạn nhận ra rằng RenderObject.hppthực sự không cần Texture.hppchính nó.

Một hệ quả là bạn không bao giờ nên bao gồm một tiêu đề trong một tiêu đề khác trừ khi nó rõ ràng là cần thiết trong tệp đó.

Nguyên tắc chung là: bao gồm những gì bạn sử dụng. Nếu bạn sử dụng một đối tượng trực tiếp, sau đó bao gồm tệp tiêu đề của nó trực tiếp. Nếu bạn sử dụng một đối tượng A sử dụng B nhưng không sử dụng B cho mình, chỉ bao gồm Ah

Ngoài ra, trong khi chúng tôi đang ở trong chủ đề, bạn chỉ nên bao gồm các tệp tiêu đề khác trong tệp tiêu đề của mình nếu bạn thực sự cần nó trong tiêu đề. Nếu bạn chỉ cần nó trong .cpp, thì chỉ bao gồm nó ở đó: đây là sự khác biệt giữa phụ thuộc công khai và riêng tư và sẽ ngăn người dùng của lớp bạn kéo theo các tiêu đề mà họ không thực sự cần.

Tôi tiếp tục tự hỏi liệu tôi có nên bao gồm rõ ràng tất cả các tiêu đề được sử dụng trực tiếp trong một tệp cụ thể không

Vâng.

Bạn không bao giờ biết khi nào những tiêu đề khác có thể thay đổi. Nó làm cho tất cả các ý nghĩa trên thế giới bao gồm, trong mỗi đơn vị dịch thuật, các tiêu đề bạn biết rằng đơn vị dịch thuật cần.

Chúng tôi có các nhân viên bảo vệ tiêu đề để đảm bảo rằng việc đưa vào hai lần là không có hại.

Ý kiến ​​khác nhau về vấn đề này, nhưng tôi cho rằng mọi tệp (dù là tệp nguồn c / cpp hoặc tệp tiêu đề h / hpp) đều có thể được biên dịch hoặc phân tích riêng.

Như vậy, tất cả các tệp nên #inc loại trừ bất kỳ và tất cả các tệp tiêu đề mà chúng cần - bạn không nên cho rằng một tệp tiêu đề đã được bao gồm trước đó.

Thật là một nỗi đau thực sự nếu bạn cần thêm một tệp tiêu đề và thấy rằng nó sử dụng một mục được xác định ở nơi khác, mà không bao gồm trực tiếp nó ... vì vậy bạn phải đi tìm (và có thể kết thúc với sai!)

Mặt khác, nó không (như một quy tắc chung) không quan trọng nếu bạn # bao gồm một tệp bạn không cần ...

Theo quan điểm của phong cách cá nhân, tôi sắp xếp các tệp #incoide theo thứ tự bảng chữ cái, chia thành hệ thống và ứng dụng - điều này giúp củng cố thông điệp "khép kín và hoàn toàn mạch lạc".

Nó phụ thuộc vào việc bao gồm quá độ là do sự cần thiết (ví dụ: lớp cơ sở) hoặc do một chi tiết thực hiện (thành viên riêng).

Để làm rõ, việc bao gồm quá độ là cần thiết khi loại bỏ nó chỉ có thể được thực hiện sau khi thay đổi giao diện đầu tiên được khai báo trong tiêu đề trung gian. Vì đó đã là một thay đổi đột phá, bất kỳ tệp .cpp nào sử dụng nó đều phải được kiểm tra.

Ví dụ: Ah được bao gồm bởi Bh được C.cpp sử dụng. Nếu Bh sử dụng Ah cho một số chi tiết triển khai, thì C.cpp không nên cho rằng Bh sẽ tiếp tục làm như vậy. Nhưng nếu Bh sử dụng Ah cho một lớp cơ sở, thì C.cpp có thể cho rằng Bh sẽ tiếp tục bao gồm các tiêu đề có liên quan cho các lớp cơ sở của nó.

Bạn thấy ở đây lợi thế thực tế của việc không trùng lặp các vùi tiêu đề. Nói rằng lớp cơ sở được Bh sử dụng thực sự không thuộc về Ah và được tái cấu trúc thành chính Bh. Bh bây giờ là một tiêu đề độc lập. Nếu C.cpp dự phòng bao gồm Ah, thì bây giờ nó bao gồm một tiêu đề không cần thiết.

Có thể có một trường hợp khác: Bạn có Ah, Bh và C.cpp của bạn, Bh bao gồm Ah

vì vậy trong C.cpp, bạn có thể viết

#include "B.h"
#include "A.h" // < this can be optional as B.h already has all the stuff in A.h

Vì vậy, nếu bạn không viết #inc loại "Ah" ở đây, điều gì có thể xảy ra? trong C.cpp của bạn, cả A và B (ví dụ: lớp) được sử dụng. Sau đó, bạn đã thay đổi mã C.cpp của mình, xóa B những thứ liên quan, nhưng để lại Bh bao gồm ở đó.

Nếu bạn bao gồm cả Ah và Bh và tại thời điểm này, các công cụ phát hiện không cần thiết bao gồm có thể giúp bạn chỉ ra rằng Bh bao gồm không còn cần thiết nữa. Nếu bạn chỉ bao gồm Bh như trên, thì thật khó để các công cụ / con người phát hiện ra sự bao gồm không cần thiết sau khi thay đổi mã của bạn.

Tôi đang thực hiện một cách tiếp cận hơi khác nhau từ các câu trả lời được đề xuất.

Trong các tiêu đề, luôn luôn chỉ bao gồm một mức tối thiểu, chỉ những gì cần thiết để thực hiện quá trình biên dịch. Sử dụng khai báo chuyển tiếp bất cứ nơi nào có thể.

Trong các tệp nguồn, điều quan trọng là bạn bao gồm bao nhiêu. Sở thích của tôi vẫn là bao gồm tối thiểu để làm cho nó vượt qua.

Đối với các dự án nhỏ, bao gồm các tiêu đề ở đây và sẽ không tạo ra sự khác biệt. Nhưng đối với các dự án vừa và lớn, nó có thể trở thành một vấn đề. Ngay cả khi phần cứng mới nhất được sử dụng để biên dịch, sự khác biệt có thể nhận thấy. Lý do là trình biên dịch vẫn phải mở tiêu đề đi kèm và phân tích cú pháp. Vì vậy, để tối ưu hóa quá trình xây dựng, hãy áp dụng kỹ thuật trên (bao gồm mức tối thiểu trần và sử dụng khai báo chuyển tiếp).

Mặc dù hơi lỗi thời, Thiết kế phần mềm quy mô lớn C ++ (của John Lakos) giải thích tất cả điều này một cách chi tiết.

Thực hành tốt là không lo lắng về chiến lược tiêu đề của bạn miễn là nó được biên dịch.

Phần tiêu đề của mã của bạn chỉ là một khối các dòng mà không ai nên nhìn vào cho đến khi bạn gặp một lỗi biên dịch dễ dàng giải quyết. Tôi hiểu mong muốn cho phong cách 'chính xác', nhưng không cách nào thực sự có thể được mô tả là chính xác. Việc bao gồm một tiêu đề cho mọi lớp có nhiều khả năng gây ra các lỗi biên dịch dựa trên thứ tự gây phiền nhiễu, nhưng các lỗi biên dịch đó cũng phản ánh các vấn đề mà mã hóa cẩn thận có thể khắc phục (mặc dù có thể cho rằng chúng không đáng để dành thời gian để sửa).

Và vâng, bạn sẽ có những vấn đề dựa trên đơn hàng khi bạn bắt đầu vào friendđất liền.

Bạn có thể nghĩ về vấn đề trong hai trường hợp.

Trường hợp 1: Bạn có một số lượng nhỏ các lớp tương tác với nhau, nói chưa đến một tá. Bạn thường xuyên thêm vào, xóa khỏi và sửa đổi các tiêu đề này theo những cách có thể ảnh hưởng đến sự phụ thuộc của chúng vào nhau. Đây là trường hợp mà ví dụ mã của bạn gợi ý.

Tập hợp các tiêu đề đủ nhỏ để không giải quyết bất kỳ vấn đề nào phát sinh. Bất kỳ vấn đề khó khăn nào đều được khắc phục bằng cách viết lại một hoặc hai tiêu đề. Lo lắng về chiến lược tiêu đề của bạn là giải quyết các vấn đề không tồn tại.

Trường hợp 2: Bạn có hàng tá lớp học. Một số lớp đại diện cho xương sống của chương trình của bạn và viết lại các tiêu đề của chúng sẽ buộc bạn phải viết lại / biên dịch lại một lượng lớn cơ sở mã của bạn. Các lớp khác sử dụng xương sống này để hoàn thành mọi việc. Điều này đại diện cho một thiết lập kinh doanh điển hình. Các tiêu đề được trải đều trên các thư mục và bạn thực sự không thể nhớ tên của mọi thứ.

Giải pháp: Tại thời điểm này, bạn cần nghĩ về các lớp học của mình trong các nhóm logic và thu thập các nhóm đó thành các tiêu đề khiến bạn không phải #includelặp đi lặp lại. Điều này không chỉ làm cho cuộc sống đơn giản hơn, nó cũng là một bước cần thiết để tận dụng các tiêu đề được biên dịch trước .

Bạn kết thúc #includelớp học bạn không cần nhưng ai quan tâm ?

Trong trường hợp này, mã của bạn sẽ trông như ...

#include <Graphics.hpp>

struct Entity {
    Texture texture;
    RenderObject render();
}