wiki:CodingGuidelines

Version 4 (modified by FrederikHeber, 13 years ago) ( diff )

input stream eof


  1. Coding Style
    1. How MoleCuilder code should look like
  2. Coding hints
    1. Some hints on good code vs. bad code
      1. end of stream checking


Coding Style

How MoleCuilder code should look like

Below you find a brief but hopefully complete list on how the code of espack should look like:

  • identate by two spaces, never tabs
  • Code Style from Eclipse, see ESPACK_codestyle.xml:
    /*
     * A sample source file for the code formatter preview
     */
    #include <math.h>
    
    class Point
    {
    public:
      Point(double xc, double yc) :
        x(xc), y(yc)
      {
      }
      double distance(const Point& other) const;
    
      double x;
      double y;
    };
    
    double Point::distance(const Point& other) const
    {
      double dx = x - other.x;
      double dy = y - other.y;
      return sqrt(dx * dx + dy * dy);
    }
    

Coding hints

Some hints on good code vs. bad code

end of stream checking

Using

   std::inputstream in;
   while (!in.eof()) {
     ..
   }

is bad. Rather one should use

   std::inputstream in;
   while (in.getline(...)) {
     ..
   }

or

   std::inputstream in;
   for(int j; in >> j;;) {
     ..
   }

or

   std::inputstream in;
   in >> j;
   if (in.fail())
    ..

This involves some extra typing but ensures that in case of faulty streams the error is properly pointed at.

Attachments (1)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.