Changes between Version 13 and Version 14 of code/C++_styleguide

Timestamp:

Apr 14, 2008, 5:05:06 PM (18 years ago)

Author:

rgrieder

Comment:

—

code/C++_styleguide

@@ -9 +9 @@
 
 == Files ==
-=== Header and Source ===
-Keep your classes/files short, don't exceed 2000 LOC (if it get's longer you may separate functions into different modules). Put every class in a separate file and name the file like the class name (use !CamelCase names). Create a separate header (ends with .h) and source file (ends with .cc) and don't include header files in header files but rather in source files if you can help it. Example for class {{{MyExampleClass}}}.
+=== General ===
+Keep your classes/files short, don't exceed 2000 LOC (if it get's longer you may separate functions into different modules). Put every class in a separate file and name the file like the class name (use !CamelCase names). Create a separate header (ends with .h) and source file (ends with .cc).
+ and don't include header files in header files but rather in source files if you can help it.
+Example for class {{{MyExampleClass}}}.
 {{{
 file names:
 MyExampleClass.cc
 MyExampleClass.h
+}}}
+
+=== Headers ===
+Keep your include dependencies in header files as little as possible. Whenever a class member is just a pointer or reference, the forward declaration is sufficient. To make that easier there exists a prerequisites file for each library, containing all the necessary forward declarations. These have to be kept up to date of course.
+Example for a header file include sequence.
+{{{
+#include "MyLibraryPrereqs.h"
+
+#include <string>              // std includes
+
+#include <OgrePrerequisites.h> // most external libraries have forward declaration files as well
+#include <OgreFrameListener.h> // only include this if you inherit from it or you don't use an object as pointer/reference
+
+#include "Projectile.h"        // our own files, if necessary
+}}}
+Note: Never ever (!!!) write {{{using namespace blah;}}} in header files! (think about what it means a little bit)
+
+=== Source files ===
+Again, keep the dependencies short. However it is not that severe in source files.[br]
+To ensure that every header file can be compiled without additional header dependencies, include class header file first.
+Include sequence is for {{{MyClass}}}:
+{{{
+#include "MyClass.h"
+
+#include <vector>              // std headers
+#include <map>
+
+#include <OgreSceneManager.h>  // external library headers
+
+#include "BaseObject.h"        // our own header files
 }}}