Changes between Version 14 and Version 15 of CodingGuidelines

Timestamp:

Mar 29, 2012, 10:56:42 AM (13 years ago)

Author:

FrederikHeber

Comment:

split up example files in header and definition

CodingGuidelines

@@ -12 +12 @@
    * identate by two spaces, never tabs
    * Code Style from Eclipse, see [attachment:ESPACK_codestyle.xml]:
+
+=== Declaration file === #style-file-declaration
+
+Your declaration file should:
+ * contain all documentation (this is what the user may see in the code, never the implementation)
+ * contain include of config.h as very first
+ * always be properly bracketed in __uniquely__ name preprocessor defines to avoid double inclusion.
+
 {{{
 /*
- * A sample source file for the code formatter preview
- */
-#include <math.h>
-
+ * Point.hpp
+ *
+ *  Created on: <creation date>
+ *      Author: <author>
+ */
+
+#ifndef POINT_HPP_
+#define POINT_HPP_
+
+// include config.h
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+/** Point is an implementation of a point in 2D space.
+ *
+ * With this we have a distance measure between two given coordinates.
+ */
 class Point
 {
 public:
+  /** Constructor for class Point.
+    * @param xc x coordinate
+    * @param yc y coordinate
+    */
   Point(double xc, double yc) :
     x(xc), y(yc)
-  {
-  }
+  {}
+
+  /** Returns distance to another Point \a other.
+   *
+   * @param other other Point
+   * @return relative euclidian distance to \a other
+   */
   double distance(const Point& other) const;
 
+  //!> internal x coordinate of this Point
   double x;
+  //!> internal y coordinate of this Point
   double y;
 };
+
+#endif /* POINT_HPP_ */
+}}}
+
+=== Definition file === #style-file-definition
+
+Your definition file should:
+ * contain a disclaimer with copyright, the year is initially the current one and should be extended whenever the file is edited again.
+ * include first config.h then !MemDebug.hpp, then your specific header file of this implementation, then all others
+
+{{{
+/*
+ * Project: MoleCuilder
+ * Description: creates and alters molecular systems
+ * Copyright (C)  2010-2012 University of Bonn. All rights reserved.
+ * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
+ */
+
+/*
+ * \file Point.cpp
+ *
+ * This file contains Point definition.
+ *
+ *  Created on: <creation date>
+ *      Author: <author>
+ */
+
+// include config.h
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+// always have the MemDebug first
+#include "CodePatterns/MemDebug.hpp"
+
+// then following by include of respective header file (without path)
+#include "Point.hpp"
+
+// then other includes
+...
+#include <math.h>
+...
 
 double Point::distance(const Point& other) const