Changes between Version 3 and Version 4 of CodingGuidelines

Timestamp:

Mar 29, 2012, 10:09:52 AM (13 years ago)

Author:

FrederikHeber

Comment:

input stream eof

CodingGuidelines

@@ -1 @@
-== How MoleCuilder code should look like ==
+
+----
+[[PageOutline(1-6,,inline)]]
+----
+
+= Coding Style = #style
+
+== How MoleCuilder code should look like == #style-file
 
 Below you find a brief but hopefully complete list on how the code of espack should look like:
@@ -31 +38 @@
 }
 }}}
+
+= Coding hints = #code
+
+== Some hints on good code vs. bad code == #code-good-bad
+
+=== end of stream checking === #code--good-bad_eof
+
+ 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.