Changes between Version 24 and Version 25 of code/C++_styleguide

Timestamp:

Sep 21, 2008, 8:11:52 PM (16 years ago)

Author:

landauf

Comment:

—

code/C++_styleguide

@@ -8 +8 @@
 
 Remember that any violation to the guide of course is allowed if it enhances readability.
+
+----
+
+== General ==
+=== this ===
+Address all member variables and functions with the this-> operator:
+{{{
+this->processData(this->data_);
+}}}
+
+=== const ===
+Use const when it's possible. This includes variables and function declaration. Specially for function'''const''' is very important. Use it always if a function doesn't change the object.
+{{{
+SomeClass.h:
+    int getSomeNumber() const;
+
+SomeClass.cc:
+    int SomeClass::getSomeNumber() const
+    {
+        return myValue_;
+    }
+}}}
+Read [wiki:PerformanceTips#constfunctions this] for more information.
+
+=== Reference ===
+Use pass-by-reference over pass-by-value when possible:
+{{{
+public:
+    void setPosition(const Vector3& position);
+    const Vector3& getPosition() const;
+
+private:
+    Vector3 myPosition_;
+}}}
+Read [wiki:PerformanceTips#constreference this] for more information.
+
+=== Initialization ===
+ * All class variables should be initialized to a sane value in the constructor.
+ * Prefer initialization to assignment in constructors.
+ * Initialize pointers with 0 or 'new ClassName'.
+
+=== Pointer ===
+ * When a member value pointer is deleted, it should be set to 0.
+ * Don't forget to delete objects in the destructor if your class is responsible for the object.
+
+=== virtual ===
+ * If a base class has virtual functions, derived classes should have the "virtual" keyword repeated for those functions.
+ * Don't use virtual functions in the constructor of the same class
+
+----
 
 == Files ==
@@ -80 +130 @@
 #endif /* _ClassName_H__ */
 }}}
+
+----
 
 == Comments ==
@@ -172 +224 @@
 }}}
 
+----
+
 == Naming Conventions ==
 
@@ -291 +345 @@
 }}}
 
+----
 
 == Indentation ==
@@ -311 +366 @@
 }}}
 
+----
+
 == Whitespaces ==
 Use one space after each keyword and enclose operators with 2 of them: {{{ if (a + b < c) }}}
@@ -333 +390 @@
 
 
+----
+
 == Statements ==
-
 
 === Access Modifiers for Classes ===
@@ -359 +417 @@
 Only loop control statements must be included in the for() construction.
 
+
+----
 
 == Layout ==
@@ -426 +486 @@
 }}}
 
+----
+
 == Special Implementations ==
 === Use STL Libraries ===
 Use STL (standard template library) implementations of common abstract data structures like lists, arrays, stacks, queues, never implement your own!
 
-== General Topics ==
+----
+
+== Compiling ==
  * different build targets possible (for subprojects)
  * different make options (make-dbg, make-opt)
  * unit test supported (in debug mode)
  * compiler mode: warnings being treated as errors
+
+----
 
 == Code Reviews ==