Wie eine Warnung geben, wenn h-Datei nicht enthalten ist, direkt

Question

nehme ich mehrere "h" Dateien haben:

First.h

struct FirstStruct { /* Stuff */ }; 
/* Other stuff */ 

Second.h

#include "First.h" 
struct SecondStruct { 
    FirstStruct member; 
    /* More other stuff */ 
}; 
/* Even more other stuff */ 

Dritter. h:

#include "Second.h" 

FirstStruct foo(void); 
/* Other functions */ 

Wenn Siebemerkenerhält die Definition von FirstStruct nicht direkt (dh von First.h), sondern weil Second.h es für sie enthält. Das Problem ist, dass, wenn ein Entwickler entscheidet, dass SecondStruct nicht wirklich das FirstStruct dort braucht es die halb äquivalente Struktur OtherStruct, und dann nimmt das Include zu First.h ...... oops jetzt nichts mit Third.h nicht tut Arbeit.

Gibt es irgendeine Semi-Standard-Compiler-Option, um Sie zu warnen, wenn Sie sich auf einen anderen h-Dateien-Include verlassen müssen?

Answer 1

Nun, wenn Sie Wachen Header haben, und der Kopfschutz für die Datei "First.h" ist FIRST_HEADER_H, Sie so etwas wie

#ifndef FIRST_HEADER_H 
/*warning*/ 
#pragma message("FREE ADVICE: You should include The file: First.h") 
#endif 

Haupt Compiler support dies tun könnte.

Auch ich denke, Sie auf dem self contained headers lesen sollten, die besagt, dass alle Dateien first.h (in diesem Beispiel) verwenden, sollten umfassen first.h so sollte third.h wahrscheinlich lesen geändert werden:

#include "First.h" 
#include "Second.h" 

FirstStruct foo(void); 
/* Other functions */ 

Answer 2

Sie dies erkennen Szenario, indem Sie feststellen, dass Ihr Programm nicht mehr kompiliert.

Dann fügen Sie #include "First.h" in Third.h (wie Sie in erster Linie — ja getan haben sollten, auch wenn Sie Second.h auch ist einschließlich) und den Fehler auf Ihrem Issue-Tracking-System zu beheben.

Es gibt keine Compiler-Warnung, die Sie einschalten können, um anzuzeigen, dass dieses Problem eines Tages auftreten könnte. C++ Compiler erwarten sehr, dass einige Symbole nur durch die Header indirekt; Auch wenn es eine schlechte Übung ist, dies in Ihrem eigenen Code bewusst zu machen, würde eine solche Warnung die Kompilierung extrem verrauscht machen, wenn Sie irgendwelche Bibliotheken verwenden (einschließlich der Standardbibliothek).

Der einzige präventive Schritt, den Sie dann machen können, ist sorgfältige Code-Überprüfung unter Gleichaltrigen und eine Projektmanagementstruktur, die es ermöglicht, unerwartete Fehler zu beheben.

Zugegeben, das ist irgendwie nervig.