Changes between Version 9 and Version 10 of CodingGuidelines

Timestamp:

Mar 29, 2012, 10:33:39 AM (13 years ago)

Author:

FrederikHeber

Comment:

added section on forward declarations

CodingGuidelines

@@ -120 +120 @@
 
 ''Note:'' If a function is ''const in nature'' but modifies a very specific variable (specific to the function but needs to be contained in the class scope, e.g. a counter how often the function has been called), make it __mutable___.
+
+=== Use forward declarations === #code-good-bad-limits-forward-declarations
+
+Whenever possible __use forward declarations__ in header files. They are ''vital in reducing compilation times''. Remember that the preprocessor first compiles every include into the file subsequently served to the compiler. The larger this file becomes, the longer compilation takes.
+
+If a function defined in a header file just has the parameter as a reference or as pointer, don't add the include but only the forward declaration in the header file.
+{{{
+// some header file
+
+class MightyClass;
+
+class SmallClass {
+  ...
+  void foo(MightyClass &_m);
+  ...
+};