Changes between Version 2 and Version 3 of Coding Style Guidelines

Timestamp:

Nov 7, 2006, 4:52:57 PM (18 years ago)

Author:

sam@webkit.org

Comment:

Finish port of Coding Style Guidelines

Coding Style Guidelines

@@ -261 +261 @@
 myUrlAccessor:
  }}}
+
+
+== Other Punctuation ==
+
+ * Constructors for C++ classes should initialize all of their members using C++ constructor synatax. Each member (and superclass) should be indented on a separate line, with the colon or comma preceding the member on that line.
+
+ '''Right:'''
+ {{{
+ #!cpp
+MyClass::MyClass(Document* doc)
+    : MySuperClass()
+    , m_myMember(0)
+    , m_doc(doc)
+{
+}
+
+MyOtherClass::MyOtherClass()
+    : MySuperClass()
+{
+}
+ }}}
+
+ '''Wrong:'''
+ {{{
+ #!cpp
+MyClass::MyClass(Document* doc) : MySuperClass()
+{
+    m_myMember = 0;
+    m_doc = doc;
+}
+
+MyOtherClass::MyOtherClass() : MySuperClass() {}
+ }}}
+
+ * Pointer types in non-C++ code — Pointer types should be written with a space between the type and the * (so the * is adjacent to the following identifier if any).
+
+ * Pointer and reference types in C++ code — Both pointer types and reference types should be written with no space between the type name and the * or &.
+
+ '''Right:'''
+ {{{
+ #!cpp
+Image* SVGStyledElement::doSomething(PaintInfo& paintInfo)
+{
+  SVGStyledElement* element = static_cast<SVGStyledElement*>(node());
+  const KCDashArray& dashes = dashArray();
+ }}}
+
+ '''Wrong:'''
+ {{{
+ #!cpp
+Image *SVGStyledElement::doSomething(PaintInfo &paintInfo)
+{
+    SVGStyledElement *element = static_cast<SVGStyledElement *>(node());
+    const KCDashArray &dashes = dashArray();
+ }}}
+
+
+== Include Statements ==
+
+ * All files must #include "config.h" first.
+
+ * All files must #include the primary header second, just after "config.h". So for example, Node.cpp should include Node.h first, before other files. This guarantees that each header's completeness is tested, to make sure it can be compiled without requiring any other header files be included first.
+
+ * Other #include statements should be in sorted order (case sensitive, as done by the command-line sort tool or the Xcode sort selection command). Don't bother to organize them in a logical order.