Naming Include Guards

by

I personally follow Boost’s recommendation. It’s perhaps one of the largest collection of C++ libraries of good quality around and they don’t have problem.

It goes like:

<project>_<path_part1>_..._<path_partN>_<file>_<extension>_INCLUDED

// include/pet/project/file.hpp
#ifndef PET_PROJECT_FILE_HPP_INCLUDED

which is:

  • legal (note that beginning by _[A-Z] or containing __ is not)
  • easy to generate
  • guaranteed to be unique (as a include guard) within a project (else you have two files at the same place)
  • guaranteed not to be used for anything else (if you end another macro with INCLUDED you’re spoiling for a fight)

I’ve read about GUID but those look weird.

And obviously I’d rather than all compilers implement #pragma once (or better, #pragma multiple and “once” be the default behavior…)

More Related Contents:

  1. Why are preprocessor macros evil and what are the alternatives?
  2. How do I see a C/C++ source file after preprocessing in Visual Studio?
  3. Is #pragma once a safe include guard?
  4. Why are #ifndef and #define used in C++ header files?
  5. Comma in C/C++ macro
  6. Combining C++ and C – how does #ifdef __cplusplus work?
  7. __FILE__, __LINE__, and __FUNCTION__ usage in C++
  8. Define preprocessor macro through CMake?
  9. MSVC++ variadic macro expansion
  10. Multi line preprocessor macros
  11. Should I use #define, enum or const?
  12. in C++ , what’s so special about “_MOVE_H”?
  13. Representing big numbers in source code for readability?
  14. C++ preprocessor: avoid code repetition of member variable list
  15. How to use Macro argument as string literal?
  16. How to make a variadic macro for std::cout?
  17. Why isn’t C/C++’s “#pragma once” an ISO standard?
  18. Can macros be overloaded by number of arguments?
  19. When can you omit the file extension in an #include directive?
  20. What’s the difference between the WIN32 and _WIN32 defines in C++
  21. Somehow register my classes in a list
  22. Can I redefine a C++ macro then define it back?
  23. Concat two `const char` string literals
  24. What is the NDEBUG preprocessor macro used for (on different platforms)?
  25. What does ## in a #define mean?
  26. Should variable definition be in header files?
  27. How do I temporarily disable a macro expansion in C/C++?
  28. How can I see the output of the Visual C++ preprocessor? [duplicate]
  29. Expand macro inside string literal
  30. #ifdef vs #if – which is better/safer as a method for enabling/disabling compilation of particular sections of code?

Leave a Comment